首页 > Windows开发 > 详细

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

时间:2018-05-24 14:19:44      阅读:4893      评论:0      收藏:0      [点我收藏+]

最近在写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://www.cnblogs.com/lenmom/p/9082423.html

(3)
(4)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!