我有一个带有500多个Missing XML Comment
警告的项目。我知道我可以删除XML注释功能,或将空的注释片段粘贴到任何地方,但是我更喜欢一种通用解决方案,在该解决方案中我可以进行更改以禁用此类型的所有警告。
我刚才所做的就是
///<Summary>
///
///</Summary>
要么
#pragma warning disable 1591
只是好奇是否有可能。
3
实际问题是什么?您是否想知道另一种禁用XML注释丢失时生成的警告的方法?在项目的属性中,更改为“构建”选项卡,然后取消选中“ XML文档文件”。但是,我建议不要隐藏警告,而是添加缺少的文档。
—
Gorgsenegger 2011年
那是绝对正确的,但只是因为我刚接触这一点而对如何才能从一个地方解决这个问题感到好奇。
—
Nivid Dholakia 2011年
仅对其他程序集可见的成员显示警告。人们通常
—
杰普·斯蒂格·尼尔森
public
没有充分的理由制作类(以及接口,枚举等)。在这种情况下,一个简单(并且我认为很好)的解决方案是仅从最外面的封闭类型中删除单词public
(或internal
根据需要的样式将其替换为冗余关键字)。然后,有关此类型及其成员的所有CS1591警告均消失。当然,您可能仍然必须保留某些类型public
。但是在那种情况下,您需要正确记录其公共部分是很公平的。