为公开可见的类型或成员缺少XML注释 [英] Missing XML comment for publicly visible type or member

查看:431
本文介绍了为公开可见的类型或成员缺少XML注释的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我收到这样的警告:缺少XML注释为公开可见的类型或成员

I am getting this warning: "Missing XML comment for publicly visible type or member".

如何解决此问题?

推荐答案

5个选项:


  • 填写文档注释(伟大的,但耗时)

  • 关闭评论一代(在项目属性)

  • 禁用项目属性警告(并非不合理;它的警告1591年)

  • 使用的#pragma警告禁止1591 来禁用警告只是(code的某些位和的#pragma警告恢复1591 之后)

  • 忽略警告(坏主意 - 你会错过新真正的警告)

  • Fill in the documentation comments (great, but time-consuming)
  • Turn off the comment generation (in project properties)
  • Disable the warning in project properties (not unreasonable; it's warning 1591)
  • Use #pragma warning disable 1591 to disable the warning just for some bits of code (and #pragma warning restore 1591 afterwards)
  • Ignore the warnings (bad idea - you'll miss new "real" warnings)

这篇关于为公开可见的类型或成员缺少XML注释的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆