KnowledgeHub
Questions
Tags
Users
Search
Alex Rivera
|
Logout
Edit Question
Title
Body
When the purpose of a method is to calculate a value and return it, I find myself documenting it as follows: /// <summary> /// Calculates the widget count. /// </summary> /// <param name="control">The control to calculate the widget count of.</param> /// <returns>The widget count.</returns> Here the returns tag does not provide any new information: it's just repeating what's in the summary . (The exception is methods that return bool , where it's easy to explain what the true and false return values mean.) Am I missing something? Is there a standard way of wording XML documentation blocks to avoid repetition between the summary and returns tags?
Tags (comma-separated)
Save Edits
Cancel