如何使用XML注釋和Doxygen記錄C＃項目/程序集？

Question

我有一個帶有XML注釋的C＃代碼庫，並且（ 由於這個站點 ）發現Doxygen可以很容易地生成轉換代碼和注釋到HTML和PDF文檔中所以我知道如何記錄類和其他類型及其內容。

但是如何記錄項目/程序集/命名空間？ 我的代碼庫有50多個; 他們的責任必須記錄在案。

我也希望只對它們使用XML注釋。 但微軟的XML評論手冊並沒有給我一個如何做到這一點的線索，我也找不到Doxygen文檔中的任何線索。

我錯過了什么？ 您如何為C＃項目/程序集提供文檔？

更新：我現在知道如何使用SHFB 。

Answer 1

我們也一直在為我們的程序集生成文檔。 我們有大約20-25 dll。 我們使用過Sandcastle [SHFB]，它是一塊蛋糕。 我們使用了以下程序。

1. 檢查Project屬性[ClassLibrary]中的XML Documentation file ，然后根據需要提供自定義路徑，否則將在bin \\ debug或bin \\ release文件夾中生成XML。
2. 然后我們將從SandCastle啟動GUI
3. 然后我們將所有必備的dll文件放在一個文件夾中，然后我們將指向UI中的dll和xml文件，然后我們將構建應用程序。 這將生成CHM以及可用於在Web上作為Web幫助發布的網頁。

谷歌搜索肯定會給你基於截圖的樣本..

如果您只需要使用doxygen，請參閱此處