如何测试我的项目中的所有函数是否都被注释为 <summary>

Question

我正在使用 jetbrains-rider / C#。我想测试一下我的所有函数是否都像

一样得到了完整的注释

    /// <summary>
    /// Add a and b
    /// </summary>
    /// <param name="a">a int</param>
    /// <param name="b">another int</param>
    /// <returns>sum of a and b</returns>
    public int Add(int a, int b);

仅在摘要注释存在的情况下，如果参数名称不匹配，Rider 将发出警告。我想要的是，如果某个功能没有相应的摘要，骑手会发出警告。或者我可以以某种方式检查代码以给出 NG 列表。

我怎样才能做到这一点？

Answer 1

您可以将其配置为给出提示、建议、警告或错误。检查工具可能默认配置为启用警告，但除非您打开 XML 文档生成，否则 Rider 不会显示它们。

打开项目的属性
对于每个配置，启用生成选项
接受默认文件位置或设置您自己的位置

应用后，您应该会看到一条警告。如果一个警告就足够了，你就完成了。如果您想为私有代码打开它，更改检查严重性，或者如果它尚未启用...

打开骑士设置
转到编辑器 -> 检查设置 -> 检查严重性 -> C#
使用“xml”搜索
找到您要添加的检查项and/or编辑
点击保存

您可以使用动态代码分析和“问题”选项卡来查看是否有任何问题违反了规则。只需确保选项卡上的视图选项包括您为其设置的级别 (Warning/Error)。

如何测试我的项目中的所有函数是否都被注释为 <summary>

How to test if all functions in my project are commented with <summary>

c#

summary

rider

code-documentation

jetbrains-rider