創建C＃代碼

我目前工作的一個C＃項目，並VisualAssist產生對我來說這些花哨/// <summary></summary>意見HTML文檔，我一直在使用他們做記錄我的代碼。創建C＃代碼

我認爲必須有使用這些意見，以創建像那些由Doxygen的或做的Javadoc HTML文檔的方式。我怎麼做？

2013-03-09 jaho

Doxygen也適用於C＃。它出什麼問題了？ – Etan 2013-03-09 22:04:48

但Doxygen使用不同的語法。由於Visual Assist已經爲我生成了這些評論，我寧願使用它們。編輯：其實也許它支持XML，我會給它一個去。 – jaho 2013-03-09 22:07:29

Doxygen或Sandcastle help file builder是將XML文檔提取到HTML（以及其他形式）外部文檔的主要工具。

請注意，您可以將這些文檔導出器與文檔生成器相結合 - 就像您發現的那樣，Resharper有一些基本的幫助器，但也有更高級的工具可以完成此特定任務，如GhostDoc（用於C＃/ VB代碼包含XML文檔）或我的插件Atomineer Pro Documentation（適用於包含XML，Doxygen，JavaDoc或Qt文檔的C＃，C++/CLI，C++，C，VB，Java，JavaScript，TypeScript，JScript，PHP，Unrealscript代碼）。

來源

2013-03-09 22:37:53

-1

這頁你可能感興趣的：http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

您可以使用命令行編譯器或通過Visual Studio界面生成XML文檔文件。如果您正在使用命令行編譯器進行編譯，請使用options/doc或/ doc +。這將通過與程序集相同的名稱和路徑生成XML文件。要指定不同的文件名，請使用/ doc：file。

如果您正在使用Visual Studio界面，有控制是否生成XML文檔文件中的設置。要設置它，請雙擊解決方案資源管理器中的我的項目以打開項目設計器。導航到編譯選項卡。在窗口底部找到「生成XML文檔文件」，並確保它被選中。默認情況下，此設置已打開。它使用與程序集相同的名稱和路徑生成XML文件。

來源

2013-03-09 22:30:12 Recurve

+10

他不問如何生成XML文檔，他問如何將該XML文檔轉換爲HTML。 – Mark 2015-05-13 20:59:56

儘管你的回答沒有回答OP的問題，但它回答了我的問題。謝謝！ – 2015-06-04 16:29:31

你可以嘗試https://www.docify.net/他們做的正是這一點。

來源

2016-07-18 21:43:50 Josiah

該項目看起來不錯，但註冊鏈接被打破 – Nic 2016-09-28 08:56:34

該網站已關閉 – Josiah 2016-12-05 04:28:38

爲Visual Studio上述方法似乎並不適用於Visual Studio的2013年，但我能找到使用Project菜單並選擇我的項目（可能在子菜單中的最後一項）所描述的複選框去與複選框（在生成選項卡上）的對話框。

來源

2017-05-03 21:03:37

2017年，離Javadoc最近的東西可能是DocFx，它由微軟開發，作爲Commmand-Line-Tool以及VS2017插件。

它的邊緣還是有點粗糙，但看起來很有希望。

另一種方法是Wyam具有適於淨aplications一個文檔配方。以cake documentation爲例。

來源

2017-06-10 07:57:42 mode777

Docfx爲我完美工作。我也爲VS2015工作 - 只需添加nuget軟件包'docfx。console'。 – 2017-07-21 08:21:43

最受讚賞的答案是從2009年開始，但今天（2017年）我會說docfx是最好的選擇。 – 2017-08-03 05:57:05

DocFX不幸的是存在很大的缺點，它只關注公衆的文檔。所以如果你想爲內部使用做一些文檔，其中也包括訪問修飾符「內部」或「私人」，這是絕對無用的。當然...你有機會自己修改代碼並修復此問題。請參閱：https：//github.com/dotnet/docfx/issues/836 – Onsokumaru 2017-12-21 13:28:25

回答

相關問題