如何将 XML 注释连接到 API 帮助页面？

Question

我正在处理一个需要在 API 帮助页面上提供文档的项目。该页面已创建，可以插入信息。但我有一些问题：

1. 我对此很陌生，因此在浏览项目时遇到了一些问题。

2. 我想引用直接在 Controller 文件中的 XML cmets，如下所示：

   /// <summary>
   /// Get all the number of help desk tickets by their current priorities
   /// </summary>
   /// <returns></returns>
   
   
   [ActionName("GetCurrentPriority")]
   public TicketPriorities GetTicketsByCurrentPriority()
   {...
   

WebApiConfig.cs 文件中的 HTTP 路由代码如下所示：

            config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{action}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

但是，我不知道如何在网络帮助页面上发表评论。我见过很多使用参数 ID 的示例，但似乎没有 ID，而且我不知道如何找到或制作参数 ID，因为帮助页面显示除了 ID 之外的所有内容。例如，我应该创建一个XMLDocument.xml 文件并将所有 cmets 放入其中吗？

Answer 1

你有这行代码吗？

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

另外不要忘记在项目属性 -> 构建中勾选“XML 文档文件”。将路径设置为App_Data\XmlDocument.xml。

您可能还想取消警告 CS1591，因为会有很多类（例如在帮助生成代码中）是 public，但不需要添加文档。

有关详细信息，请参阅此文档：http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages