小编给大家分享一下ASP.NET Web API怎么将注释自动生成帮助文档，相信大部分人都还不怎么了解，因此分享这篇文章给大家参考一下，希望大家阅读完这篇文章后大有收获，下面让我们一起去了解一下吧！
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怎么将注释自动生成帮助文档”这篇文章的所有内容，感谢各位的阅读！相信大家都有了一定的了解，希望分享的内容对大家有所帮助，如果还想学习更多知识，欢迎关注亿速云行业资讯频道！
免责声明：本站发布的内容（图片、视频和文字）以原创、转载和分享为主，文章观点不代表本网站立场，如果涉及侵权请联系站长邮箱：is@yisu.com进行举报，并提供相关证据，一经查实，将立刻删除涉嫌侵权内容。
