码迷,mamicode.com
首页 > Windows程序 > 详细

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

时间:2018-05-24 15:10:07      阅读:1171      评论:0      收藏:0      [点我收藏+]

标签:https   api   今天   href   打开   style   tab   分享图片   技术   

最近在写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 注释 问题解决

标签:https   api   今天   href   打开   style   tab   分享图片   技术   

原文地址:https://www.cnblogs.com/lenmom/p/9082423.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!