文档注释中缺少摘要¶
ID: cs/xmldoc/missing-summary
Kind: problem
Security severity:
Severity: recommendation
Precision: high
Tags:
- maintainability
Query suites:
- csharp-security-and-quality.qls
文档注释应包含一个 <summary> 标记，简要描述类或方法的用途。
建议¶
向任何没有 <summary> 标记的文档注释添加一个。
示例¶
以下示例显示了一个描述类的 <summary> 标记。
/// <summary>
/// A minimal threadsafe counter.
/// </summary>
class AtomicCounter
{
// ...
}
参考¶
MSDN，C# 编程指南：XML 文档注释，操作方法：使用 XML 文档功能，文档注释的建议标记。