CodeQL documentation

Missing a summary in documentation comment

ID: cs/xmldoc/missing-summary
Kind: problem
Security severity: 
Severity: recommendation
Precision: high
   - maintainability
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.


Add a <summary> tag to any documentation comments which do not have one.


The following example shows a <summary> tag describing a class.

/// <summary>
///   A minimal threadsafe counter.
/// </summary>
class AtomicCounter
    // ...


  • © GitHub, Inc.
  • Terms
  • Privacy