在/ Help页面上自动化ASP MVC.NET Web api文档

Question

我一直在按照说明为Web API创建帮助页面的说明，例如http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages

我知道要获取REST路径的描述，请将这些xml注释放在相应的方法之上。

/// <summary>
/// Looks up some data by ID.
/// </summary>
/// <param name="id">The ID of the data.</param>

但是说我有很多路径或许多Web API项目，我想让这个过程更快一些。如果我想要简单的1句话描述自动化，我可以从哪里开始。我可以，通过简单的描述，可以从方法名称的名称或约定中提取，并提及它期望的参数类型。只是非常简单的东西来构建。

我最初认为这个自动化项目将与您所定位的Web API位于同一解决方案中，它只是另一个单独的项目。感谢。

Answer 1

如果您安装了GhostDoc，则可以点击某种方法，然后按Ctrl + Shift + D。这将添加所有基本的XML doc元素，但它也会尝试提供一个简单的描述，该方法的作用，参数是什么以及通过查看名称返回的内容，以及根据惯例计算出的内容。 。描述通常不是很有用，但有时它们可​​以。我想你只需要适应他们的惯例。