【问题标题】:Visual Studio: Warn on Missing XML Documentation for Private and Internal MembersVisual Studio:警告私有和内部成员缺少 XML 文档
【发布时间】:2009-07-23 16:15:11
【问题描述】:

我正在使用 Visual Studio 2005 (VS.8.0),并且我希望强制要求记录所有类成员,而不仅仅是公共成员。虽然设置 Visual Studio 以在未记录公共、受保护或内部受保护成员时生成警告很简单,但我正在寻找一种方法让私有和内部成员抛出同样的警告。有什么建议吗?

注意:我使用的是 4 级警告,将警告视为错误,并设置了生成 XML 标志。

【问题讨论】:

  • 你有没有想过这个问题?我会对答案感兴趣。
  • @rwmnau - 不,还没有。我猜想自动检查没有办法做到这一点,所以我一直在手动进行。这就是生活......

标签: visual-studio compiler-warnings xml-documentation


【解决方案1】:

不幸的是,Visual Studio 2005 没有提供一种对私有或内部成员和类型强制执行 XML 文档的方法。

我建议尝试StyleCop,但它不支持 Visual Studio 2005(事实上,the latest version 甚至不再支持 Visual Studio 2008,很遗憾)。但是,StyleCop 可以设置为对所有成员强制执行文档。

但一切都不会丢失,因为 StyleCop 现在是开源的,因此您可以获取源代码并使用它来激发您自己的 Visual Studio 2005 插件,该插件模仿此特定操作。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-01-24
    • 2022-10-15
    • 1970-01-01
    • 2010-10-25
    相关资源
    最近更新 更多