自动在MVC.NET页面上实现/Help Web文档的自动化

Question

我一直在遵循关于为Web创建帮助页的说明，其中一个例子是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项目，我想让这个过程更快一些。如果我想要一个简单的句子描述被自动化，我可以从哪里开始。我可以用简单的描述从方法名的名称或约定中提取，并提到它所期望的参数类型。只是一些很简单的东西。

我最初认为这个自动化项目将驻留在与您所针对的Web相同的解决方案中，它只是另一个单独的项目。谢谢。

Answer 1

如果安装GhostDoc，可以单击方法并按Ctrl + Shift + D。这将添加所有基本的XML元素，但它也将试图通过查看名称和按约定计算出一些简单的描述来说明该方法的作用、参数是什么以及返回什么。这些描述通常不是很有用，但有时它们是可以的。我想你只要适应他们的习惯就行了。