c# - 断言方法标签的存在

Question

这里是否可以断言summary标签存在？

/// <summary> this is my summary </summary>
public void myMethod()
{
    // dostuff
}

我的方法文档依赖于 summary/category/param 等标签，我想确保每个方法都有指定的标签？

Answer 1

代码分析器就是为这种情况而创建的。您可以在构建期间生成错误，而不是使用单元测试来验证代码是否具有正确的注释。

对于这种特殊情况，现有的 StyleCop 分析仪可以为您完成这项工作。 SA1600 ElementsMustBeDocumented和 SA1604 ElementDocumentationMustHaveSummary听起来正是您想要的。

因此，如果您添加 StyleCop analyzers到您的解决方案/项目，然后将 SA1600 和 SA1604 设置为错误，然后在提供文档之前阻止代码构建。

如果出于某种原因不符合您的需求，您始终可以创建自己的分析器来涵盖您的用例。