ASP.NETWebAPI怎么将注释自动生成帮助文档-创新互联

小编给大家分享一下ASP.NET Web API怎么将注释自动生成帮助文档，相信大部分人都还不怎么了解，因此分享这篇文章给大家参考一下，希望大家阅读完这篇文章后大有收获，下面让我们一起去了解一下吧！

创新互联长期为数千家客户提供的网站建设服务，团队从业经验10年，关注不同地域、不同群体，并针对不同对象提供差异化的产品和服务；打造开放共赢平台，与合作伙伴共同营造健康的互联网生态环境。为德令哈企业提供专业的成都做网站、成都网站制作，德令哈网站改版等技术服务。拥有十载丰富建站经验和众多成功案例,为您定制开发。

 ASP.NET Web API从注释生成帮助文档

默认情况下，ASP.NET Web API不从Controller的注释中生成帮助文档。如果要将注释作为Web API帮助文档的一部分，比如在帮助文档的Description栏目中显示方法注释中的summary，需要进行一些配置操作。

首先在Visual Studio中打开Web API项目的属性页，在Build设置页，选中XML document file，输入将要生成的XML文件放置的路径，比如：App_Data\OpenAPI.XML。

然后编译项目，就会在对应的路径下生成xml文件。

接着打开 Areas\HelpPage\App_Start\HelpPageConfig.cs 文件，取消 config.SetDocumentationProvider 代码的注释，修改一下路径：

然后重新编译，访问 /help 页面，就能看到效果了。

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")))

以上是“ASP.NET Web API怎么将注释自动生成帮助文档”这篇文章的所有内容，感谢各位的阅读！相信大家都有了一定的了解，希望分享的内容对大家有所帮助，如果还想学习更多知识，欢迎关注创新互联行业资讯频道！

分享文章：ASP.NETWebAPI怎么将注释自动生成帮助文档-创新互联
文章链接：http://bjjierui.cn/article/dcodde.html