小編給大家分享一下ASP.NET Web API怎么將注釋自動生成幫助文檔，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

創(chuàng)新互聯(lián)長期為數(shù)千家客戶提供的網(wǎng)站建設(shè)服務(wù)，團隊從業(yè)經(jīng)驗10年，關(guān)注不同地域、不同群體，并針對不同對象提供差異化的產(chǎn)品和服務(wù)；打造開放共贏平臺，與合作伙伴共同營造健康的互聯(lián)網(wǎng)生態(tài)環(huán)境。為德令哈企業(yè)提供專業(yè)的成都做網(wǎng)站、成都網(wǎng)站制作，德令哈網(wǎng)站改版等技術(shù)服務(wù)。擁有十載豐富建站經(jīng)驗和眾多成功案例,為您定制開發(fā)。

 ASP.NET Web API從注釋生成幫助文檔

默認情況下，ASP.NET Web API不從Controller的注釋中生成幫助文檔。如果要將注釋作為Web API幫助文檔的一部分，比如在幫助文檔的Description欄目中顯示方法注釋中的summary，需要進行一些配置操作。

首先在Visual Studio中打開Web API項目的屬性頁，在Build設(shè)置頁，選中XML document file，輸入將要生成的XML文件放置的路徑，比如：App_Data\OpenAPI.XML。

然后編譯項目，就會在對應(yīng)的路徑下生成xml文件。

接著打開 Areas\HelpPage\App_Start\HelpPageConfig.cs 文件，取消 config.SetDocumentationProvider 代碼的注釋，修改一下路徑：

然后重新編譯，訪問 /help 頁面，就能看到效果了。

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

以上是“ASP.NET Web API怎么將注釋自動生成幫助文檔”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對大家有所幫助，如果還想學習更多知識，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道！

名稱欄目：ASP.NETWebAPI怎么將注釋自動生成幫助文檔-創(chuàng)新互聯(lián)
本文鏈接：http://weahome.cn/article/dcodde.html