vs2010代碼注釋自動生成api文檔


最近做了一些接口,提供其他人調用,要寫個api文檔,可是我想代碼注釋已經寫了說明,能不能直接把代碼注釋生成api?於是找到以下方法

環境:vs2010

先下載安裝Sandcastle 和Sandcastle Help File Builder

下載地址

http://sandcastle.codeplex.com/

http://shfb.codeplex.com/

其中Sandcastle Help File Builder安裝較復雜,安裝紅框內的即可

 

安裝完成后,然后讓要使用的項目輸出xml文檔文件

 

重新生成,能看到輸出目錄多了這個xml

 

打開Sandcastle Help File Builder GUI

在右邊的project explorer,加載文檔資源

PS:這里推薦加載上述輸出的xml或dll(或exe),雖然加載工程文件(擴展名*.csproj)也行,但在生成文檔是使用后者的速度慢很多,不知為何

 

然后說說 工程屬性 的關鍵幾個

這里可以選擇不同格式,我選了chm

help file是文檔標題,輸出文件名,文檔語言,表現風格等

visibility比較關鍵,控制屬性哪些項(私有成員,公有成員,方法,屬性,構造函數,基類成員,.net基類成員等),還能控制輸出我們寫的

哪個類,點擊【edit API Filter】進入詳細控制

missing tags是是否高亮顯示沒寫的注釋,我不想提示,所以大部分沒勾

Paths填文件的輸出路徑

設置完畢后,開始build

輸出效果


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM