在自動化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文檔元素，但它也會嘗試對該方法執行什麼操作，參數是什麼以及通過查看名稱返回的內容進行簡單描述，然後通過常規方式計算出某些內容。描述通常不是很有用，但有時候可以。我想你只需要適應一下他們的習慣。