手机
当前位置:查字典教程网 >编程开发 >asp.net教程 >ASP.NET Web API如何将注释自动生成帮助文档
ASP.NET Web API如何将注释自动生成帮助文档
摘要:ASP.NETWebAPI从注释生成帮助文档默认情况下,ASP.NETWebAPI不从Controller的注释中生成帮助文档。如果要将注释...

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

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

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

ASP.NET Web API如何将注释自动生成帮助文档1

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

接着打开 AreasHelpPageApp_StartHelpPageConfig.cs 文件,取消 config.SetDocumentationProvider 代码的注释,修改一下路径:

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

复制代码 代码如下:

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

通过以上的简单介绍,希望对大家有所帮助

【ASP.NET Web API如何将注释自动生成帮助文档】相关文章:

ASP.NET OutputCache详解

ASP.Net生成一个简单的图片

ASP.NET2.0服务器控件之自定义状态管理

ASP.NET Web API实现POST报文的构造与推送

ASP.NET 用户多次登录的解决方法

ASP.NET存取XML实例代码与注解

ASP.NET User Control使用技巧一则

ASP.NET MVC中将控制器分离到类库的实现

ASP.NET 2.0服务器控件开发之复杂属性

ASP.NET方法如何重载的必备条件

精品推荐
分类导航