1. 程式人生 > >C# CS1591 缺少對公共可見類型或成員的 XML 註釋 問題解決

C# CS1591 缺少對公共可見類型或成員的 XML 註釋 問題解決

col 語句 禁止 技術 class blog 分享圖片 alt 生成

最近在寫web api的項目,用到微軟的Web api help page組件,用於自動對生成API文檔,見博文: https://www.cnblogs.com/lenmom/p/9081363.html, 效果很好,但是問題來了,今天打開代碼一看,好多警告

CS1591 缺少對公共可見類型或成員的 XML 註釋

是由於代碼編寫不規範造成的,為了消除這些警告,可能的方法如下:

1. 項目->屬性-生成,禁止限制警告,輸入1591,警告編號,這是針對整個項目級別的

技術分享圖片

2. 代碼中加入一下代碼,用於禁止警告,註意,這個只是針對文件級別的

#pragma warning disable    1591

如果想要恢復顯示警告提示,則使用以下語句

#pragma warning restore    1591

3. 不生成xml文檔,則不會顯示該警告,但是在該場景中不使用本方法。

技術分享圖片

C# CS1591 缺少對公共可見類型或成員的 XML 註釋 問題解決