是否有一种方法可以获得编译器对非公共类中缺少XML注释的警告?

本文关键字:警告 注释 XML 编译器 一种 方法 是否 | 更新日期: 2023-09-27 18:01:34

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

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

是否有办法得到这样一个内部类的编译器警告?

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

是否有一种方法可以获得编译器对非公共类中缺少XML注释的警告?

你可以看看微软的StyleCop(托管在CodePlex上)

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

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

查看以SA1600开头的规则