c# - 如何强制文档评论

Question

我有一个 SDK，很少有开发人员可以编辑和添加新方法。我想强制每个添加新功能的开发人员添加记录的评论。记录的评论应包括此方法的受支持版本。对于摘要，我添加了 XML 文档文件并且它对我有用(如果没有记录的注释，构建将失败)支持的版本评论我还是没有解决

    /// <summary>
    /// Function1 description
    /// </summary>
    /// <**supportedSince**>Version 5.6</**supportedSince**>
    public List<string> Function1{ get; set; }

Answer 1

Warning CS1591 XML comments are missing时生成

您可以将单个警告视为错误 - 必须对使用相关源代码的每个项目执行此操作。参见 /warnaserror

因此您可以将此编译器选项添加到每个项目的设置中:

  /warnaserror:1591