1. 首頁
  2. 問答
  3. Visual Studio C++文檔生成器

Visual Studio C++文檔生成器

2010-05-15 152 views

回答

20

您也可以使用支持VS2010的XML文檔格式。 http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx

評論你的代碼後，你可以使用Sandcastle創建一個類似MSDN的文檔：http://sandcastle.codeplex.com/。 （這是Sandcastle的GUI代表，它使用起來更容易：https://github.com/EWSoftware/SHFB）

我使用AtomineerUtils自動創建XML-Documentation標頭。這個工具會幫助你很多。您可以在這裏獲得免費的版本：http://www.atomineerutils.com/products.php

來源

2010-05-15 14:48:46 Simon

+3

+1 - 這不僅會產生很好看的文檔，編譯器會用輸出的類型來註釋輸出，並且這些註釋會附加到其他各種好東西上。如果您需要故障轉移到跨平臺的東西，Doxygen也可以識別這種格式。 – 2010-05-15 15:43:23

+2

我很難找出一個C++項目，我發現這個：提供支持非託管C++（http://sandcastle.codeplex.com/workitem/3855）和示例使用C/C++項目？ （http://shfb.codeplex.com/discussions/217100/）。那麼真的有可能使用Sandcastle作爲本地C++嗎？ – 2012-08-15 07:04:46

+0

[GhostDoc]（http://submain.com/products/ghostdoc.aspx）和[CppTripleSlash]（https://visualstudiogallery.msdn.microsoft.com/22333333-fd6f-4dcb-8223-52701eddd7ad）是其他替代方法自動創建xml文檔標題 – tcb 2015-04-26 15:42:26

1

生成文檔的一種方法是 - 你猜對了 - javadoc。您只需按照通常的方式發表評論，並且javadoc在將它們轉換爲HTML/LaTeX風格方面做得很好。

當然，這不是唯一的解決方案。我會爲其他人留下空間。

來源

2010-05-15 14:48:04

+1

嗯.. Java和C++是相似的，但他們都不是相似的。當Javadoc在源代碼中遇到類似模板等事情時，不知道該怎麼做。 – 2010-05-15 15:41:44

+0

@比利：雖然你可以在Doxygen上使用Javadoc風格的評論。 – 2010-05-15 16:02:17

13

你可以看看Doxygen。

來源

2010-05-15 15:07:53 KTC

+0

我必須說我對Doxygen沒有印象。即使現在（2017年），似乎也無法生成自動包含參數類型的參數文檔，您認爲這將是一個非常基本的要求。 – Neutrino 2017-01-05 14:43:12

+0

這是C++ btw。 – Neutrino 2017-01-05 15:07:10

3

您可以使用我的插件Atomineer Pro Documentation快速生成Documentation-XML，Doxygen，Qt或JavaDoc格式的文檔註釋。然後使用Sandcastle（DocXml）或Doxygen（DocXml，Doxygen，Qt，Javadoc）將此文檔轉換爲外部文檔文件。

我推薦使用DocXml格式，因爲所有上述工具都可以使用它，而Visual Studio可以識別它（它的語法是它的顏色，它將文檔構建到它的intellisense數據庫中，因此它在工具提示幫助中出現在您的代碼中鍵入類/方法名稱）。

來源

2010-05-15 16:01:33

相關問題

 相關問題