Visual Studio禁用缺少XML注释警告
Niv*_*kia 183 visual-studio-2010 xml-comments
我有一个超过500个Missing XML Comment警告的项目.我知道我可以删除XML注释功能,或者在任何地方粘贴空注释片段,但我更喜欢通用的解决方案,我可以进行一次更改,禁用此类型的所有警告.
我现在所做的就是投入
///<Summary>
///
///</Summary>
要么
#pragma warning disable 1591
如果可能的话,只是好奇.
Gor*_*ger 295
如上所述,一般来说,我认为不应忽略(抑制)这些警告.总而言之,警告的方法是:
- 通过改变项目取消警告
Properties>Build>Errors and warnings>Suppress warnings输入1591 - 添加XML文档标记(GhostDoc可以非常方便)
- 通过编译器选项抑制警告
- 取消选中项目的"XML文档文件"复选框
Properties>Build>Output - 添加
#pragma warning disable 1591在相应文件的顶部和#pragma warning restore 1591底部
- 请不要使用GhostDoc.如果可以从方法名称推断出评论,则可以由人更好地推断出评论.这增加了零值.那段时间会更好地用自己祝贺一个名字很好的方法. (158认同)
- @Gorgsenegger:不是这种情况.它不是有缺陷的工具,而是整个概念.如果这是您想要的,VS2012将方法/参数存根添加到标准化XML注释中.但添加注释只是方法名称的更长版本并将其称为文档只是视觉上的混乱. (32认同)
- 如果它只是添加占位符,那将是一个很好的节省时间,但是我看到开发人员离开生成的文本的代码库的数量使我们认为我们只是集体成熟到不足以使用它.注释是一个(通常是必要的)代码,它不是自我记录的代码,通过提供快捷方式,这个工具对世界代码有负面的净收益. (29认同)
- 我不同意,GhostDoc帮助我快速添加所需的参数列表和返回标记(如果方法不是无效的话).我确实使用并喜欢它,而且我也认识其他一些人.但是,总结中的描述可能需要进行一些编辑,但在这种情况下,这对于大多数自动机构来说都很重要. (23认同)
- @JRoughan:我完全同意.最糟糕的是,当您最终找到时间来正确记录代码时,这些工具无法分辨您的真实文档覆盖范围.任何计算文档覆盖率的工具总是100%读取.因此,您必须经历阅读*每个*XML注释并评估是否足以记录代码的精神枯竭的任务.在一个大型项目上完成这个,我可以告诉你,这根本不好玩.请大家!不要使用这些自动文档工具! (22认同)
- 一个工具和它的用户一样好 - 如果你使用GhostDoc然后不修改生成的文档,结果如上所述.对于我和我团队中的其他人来说,它可以很好地工作,您可以使用生成的内容并根据需要进行更改.当然,每个人都应该使用他们喜欢的东西,但我通常不会把它妖魔化:) (6认同)
- 您还可以将它与StyleCop结合使用,这样您就可以显示例如XML注释标签,而不会将内容作为警告.我认为自我记录代码应该足够并且我不同意这是非常大胆的事情.然而,没有任何IDE,工具或插件可以减轻开发人员的"思考"过程...... (4认同)
- @HiredMind VS2010也是如此,我只想补充一下.使用GhostDoc的唯一原因是自动从继承的方法复制文档,如果接口已经很好地记录,这通常就足够了. (3认同)
- @dialer,那么为什么文档生成器不会自动继承丢失的文档？如果界面的文档被更新而实施者的文档陈旧,该怎么办？ (2认同)
小智 67
禁用警告:转到项目属性(右键单击项目,然后从上下文菜单中选择"属性")转到"构建"选项卡
将1591添加到抑制警告文本框中
- 感谢您回答这个问题而不是讲授是否要取消警告! (7认同)
- 像逗号分隔列表的魅力:"S125,CS1591,S1172".建成后,警告消失了. (4认同)
小智 14
您还可以修改项目的.csproj文件，以<noWarn>1591</noWarn>在第一个文件中包含一个标记<PropertyGroup>。最初来自Alexandru Bucur在这里的文章
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
...
<noWarn>1591</noWarn>
</PropertyGroup>
...
</Project>
- 这应该是当前的答案。 (3认同)
- 同意。大多数答案不适用于其他编辑器，例如 Visual Studio Code。 (3认同)
Visual Studio 2022：
我建议使用.editorconfigVisual Studio 中的文件在所有解决方案中设置通用代码样式。
在这种情况下，只需将此代码手动添加到文件中.editorconfig：
# SA0001: XML comment analysis is disabled due to project configuration
dotnet_diagnostic.SA0001.severity = none
注意：对我来说，SA0001从编辑器配置设计器中抑制不起作用。
仅在文件中手动设置规则。
| 归档时间： |
|
| 查看次数： |
75926 次 |
| 最近记录： |