Missing a summary in documentation comment¶
ID: cs/xmldoc/missing-summary
Kind: problem
Security severity:
Severity: recommendation
Precision: high
Tags:
- quality
- maintainability
- readability
Query suites:
- csharp-security-and-quality.qls
Click to see the query in the CodeQL repository
Documentation comments should contain a <summary> tag which briefly describes the purpose of the class or method.
Recommendation¶
Add a <summary> tag to any documentation comments which do not have one.
Example¶
The following example shows a <summary> tag describing a class.
/// <summary>
/// A minimal threadsafe counter.
/// </summary>
class AtomicCounter
{
// ...
}
References¶
MSDN, C# Programming Guide: XML Documentation Comments, How to: Use the XML Documentation Features, Recommended Tags for Documentation Comments.