c# - 有没有办法让编译器在非公共(public)类中缺少 XML 注释时发出警告?

标签 c# visual-studio

在我的项目中,几乎所有类都是内部的(而不是公共(public)的)。

现在我想记录所有内容(类及其公共(public)成员)。不幸的是,针对缺少 XML 注释的编译器警告似乎只包括公共(public)类及其成员。

有什么办法可以让内部类得到这样的编译器警告吗?

(使用 Visual Studio 2010 Ultimate,C# 4.0)

最佳答案

可以查看StyleCop由 Microsoft(托管在 CodePlex 上)。

这是一个非常好的基于规则的工具,它集成到 Visual Studio 中并扫描您的解决方案以查找任何样式问题。

其规则的一部分称为“文档”,指的是与记录代码相关的各种代码样式。

查看以 SA1600 开头的规则

关于c# - 有没有办法让编译器在非公共(public)类中缺少 XML 注释时发出警告?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/6637025/

相关文章:

c# - 如何在 doxygen 类图中只显示类名?

c# - 列表上的哈希函数独立于其中的项目顺序

c# - sql语句c#有问题

visual-studio - 无法在Visual Studio 2013中加载一个或多个断点错误

c++ - 如何设置从 CreateProcess 创建的进程的入口点

c# - 嵌套 View 模型 : Button actions and Communication?

c# - 从一个线程多次调用 NetworkStream.BeginWrite 是否安全?

visual-studio-2010 - 是否可以在同一台计算机上安装两个不同版本的 Visual Studio?

c# - 在运行时导出自定义 EditorFormatDefinition

c# - 分析内部 .NET Framework 方法所花费的时间