WebAPI APIExplorer文档没有收到我的摘要评论

时间:2013-10-16 01:53:55

标签: asp.net-web-api asp.net-mvc-apiexplorer

使用http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages文档指南并在每个公共API控制器上应用这些指南

/// <summary>
///  My own description comments
/// </summary>

但不知何故,我的Summaries评论没有被XML生成器ApiExplorer接收。

有什么想法吗?

1 个答案:

答案 0 :(得分:11)

在解决方案资源管理器中,右键单击项目并转到“属性”。在“构建”选项卡中,选中“XML文档文件”复选框。

然后将生成的XML文件从bin文件夹复制到项目中,通常是“App_Data”文件夹。引用帮助页面MVC区域的HelpPageConfig.cs中的文件。将有一个注释掉的行看起来像config.SetDocumentationProvider(new XmlDocumentationProvider( HttpContext.Current.Server.MapPath("~/App_Data/Doc.xml")));更改XML文件名并取消注释该行。