StandardComments.txt

Last Update: Ryan Taylor 2016/03/03

Use these standard comments when creating your code.
For complete coverage we should be not only adding comments on the class,
but also on the METHOD HEADER for each public method in those classes.

Any CSharp class files you create:
place starting on first line of file.
	/// <summary>
	/// Your Name
	/// Created: yyyy/mm/dd
	/// 
	/// Actual summary of the class if needed, example is for DTO
	/// Class for the creation of User Objects with set data fields
	/// </summary>
	///
	/// <remarks>
	/// Updater Name
	/// Updated: yyyy/mm/dd
	/// </remarks>
	
	using....
	

Standard Presentation layer METHOD HEADER comments:
	/// <summary>
	/// Your Name
	/// Created: yyyy/mm/dd
	/// 
	/// Actual summary of the class if needed.
	/// </summary>
	///
	/// <remarks>
	/// Updater Name
	/// Updated: yyyy/mm/dd 
	/// example: Fixed a problem when user inputs bad data
	/// </remarks>
	/// <param name="sender"></param>
	/// <param name="e"></param>
	public bool ExampleMethod()...


Standard DAL/BLL METHOD HEADER commenting:
	/// <summary>
	/// Your Name
	/// Created: yyyy/mm/dd
	/// 
	/// Actual summary of the class.
	/// </summary>
	///
	/// <remarks>
	/// Updater Name
	/// Updated: yyyy/mm/dd
	/// example: Fixed a problem when user inputs bad data
	/// </remarks>
	/// <param name="paramName">A description of the parameter that this method takes</param>
	/// <exception cref="SQLException">Insert Fails (example of exception tag)</exception>
	/// <returns>Rows edited</returns>