C#问题——CS1591 缺少对公共可见类型或成员的 XML 注释

声明：本文为个人笔记，用于学习研究使用非商用，内容为个人研究及综合整理所得，若有违规，请联系，违规必改。

---

C#问题——CS1591 缺少对公共可见类型或成员的 XML 注释

---

---

开发环境

VS 2019

---

一、问题描述:

VS提示:
CS1591 缺少对公共可见类型或成员的 XML 注释

数据类,生成DLL时,为了阅读方便,在属性中生成了对应注释的XML文件.此时部分未注释的属性提示.内容如图一所示.

图一

---

二、解决方案:

方案一(推荐):

项目->属性-生成，禁止限制警告，输入1591，警告编号，这是针对整个项目级别的(如图二)

图二

方案二:

代码中加入一下代码，用于禁止警告，注意，这个只是针对文件级别的

#pragma warning disable    1591

如果想要恢复显示警告提示，则使用以下语句

#pragma warning restore    1591

方案三:

不生成xml文档，则不会显示该警告，但是在该场景中不使用本方法如图三所示:

图三

方案四:

把所有字段属性全局变量等均注释上.则提示消失.

---

总结

保持饥饿,保持愚蠢.

这世界唯一能够相信的就是你付出的努力和你走过的路.