Save yourself a lot of time and remove all the comments, except these
/// <summary>
/// Method: Allow user to enter valid input for Length Calculator
/// <paramref name="LengthCalculatorOption"/> Read the input for user's option
/// <paramref name="ValidLengthCalculatorOption"/> Determine the validation of input for user's option
/// </summary>
You do not need the pre
and post
stuff either. The <summary>
should look like this:
/// <summary>
/// Allow user to enter valid input for Length Calculator.
/// </summary>
/// <paramref name="LengthCalculatorOption"/> Read the input for user's option
/// <paramref name="ValidLengthCalculatorOption"/> Determine the validation of input for user's option
No need for the word Method
in the summary. Keep your comments minimal, as that aids readability to anyone who needs to know what the method does.
Don't bother with comments in the code unless they do provide value. Too many comments can make reading the code harder, not easier.
EDIT:
I just looked at an XML comment that I wrote and noticed that I make use of the <param>
rather than <paramref>
e.g.
/// <summary>
/// Blah, blah.
/// </summary>
/// <param name="targetSiteId">The target site identifier.</param>
You should use <paramref>
if you are referencing a parameter in another part of the comment e.g.
/// <summary>
/// Blah, blah.
/// </summary>
/// <param name="targetSiteId">The target site identifier.</param>
/// <remarks>Note that the <paramref name="targetSiteID" /> should be non zero.</remarks>