.Net Core Swagger配置注释

xml文档可以自动生成

勾选上xml文档文件


 

右击项目重新生成即可出现xml文档

 给刚生成的xml文档配置如下

在Startup.cs中配置如下

  ///文档注释xml
                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
                var xmlPath = Path.Combine(basePath, "API.xml");//此处更改你的xml文档名字
                c.IncludeXmlComments(xmlPath);

控制器如下

效果如下

     vs里检测代码规则里有一项是: 视为错误的警告: 缺少对公共可见类型或成员“***********”的 XML 注释    

              但是对于接口编程来说,我觉得注释应该写在接口里,实现类不需要写,接口实现如果不写成public就不能被spring反射使用,但是使用了public就会出来这个视为错误的  警告,取消方法如下:

      项目右键属性----》生成下 “取消警告(S)”填写“1591”即可,这样原来的代码检测任然可以用,只是少了一项,不影响对代码整体的检测,没有必要向有些人说的,全部取消检测。
————————————————
版权声明:本文为CSDN博主「Anderslu」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/anderslu/article/details/6660394

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值