如何强制文档评论

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