检查Visual Studio文件以获取代码注释

时间:2009-09-11 21:10:44

标签: c# visual-studio-2008

我正在寻找一个Visual Studio 2008加载项或宏,它将检查所有.cs文件并报告“代码注释覆盖率”。我们公司的标准是所有C#类,方法和属性都是代码注释。我有一个很大的解决方案,手工浏览文件浪费了很多时间。如果我有一份报告告诉我哪些文件具有代码注释以及哪些文件没有,我可以检查这些文件。

我不介意写一些代码来实现这一目标,但我不想重新发明轮子。是否有加载项或宏来执行此操作?如果失败了,有没有办法使用反射或System.CodeDom命名空间来检查类的代码注释?如果我可以将我的类加载到对象模型中,我可能会在那里完成其余的工作。

2 个答案:

答案 0 :(得分:5)

StyleCop检查有关类和类成员的XML文档。

答案 1 :(得分:5)

只需在项目构建设置中启用XML documentation输出,然后启用“所有警告为错误”。现在,您将获得任何未公开的类以及非私有或内部成员的错误。

Visual Studio的Ghost Doc扩展程序非常适合在此处减少打字工作,并且它是免费的。

Sandcastle Help File Builder是将所有文档工作引导到漂亮的HTML,CHM或HxS文件中的最简单方法。

最后一件很酷的事情:reference code regions可以将其作为示例包含在您的文档中。将这些单元测试作为文档进行回收并确保样本正确:两只一石二鸟! : - )