類似Javadoc的C++文檔

Question

是否有類似Javadoc的文檔生成系統，用於C++？ Javadoc產生很好的輸出;如果你可以在其他語言中使用類似的東西，那將會很棒。

Answer 1

有工作方式類似於JavaDoc中對C幾種工具++最流行的工具可能是Doxygen。它可以處理類似JavaDoc的註釋，還可以處理多種語言（例如，C++，C，Java，Objective-C，Python，PHP，C＃）。它對使用CSS調整HTML輸出風格有很好的支持（例如參見users list文檔）。選擇文件系統時，

兩個重要問題是，以確保它可以讓你

• 文檔，你所感興趣的實體。你想記錄系統根據下面的代碼結構或其他一些模塊部門。
• 根據需要獲取格式化的輸出。文檔最好符合您的一般項目風格。

我們使用doxygen的經驗是它很容易設置和使用，並且生成的輸出很容易調整。不幸的是，doxygen並不完美，所以在某些情況下，需要解決doxygen解析器崩潰的怪癖或錯誤。請務必仔細檢查您生成的所有文檔。

Answer 2

有Doxygen

Answer 3

不能使用的javadoc明確，但有你想要什麼做一對夫婦的工具。大多數人傾向於使用的是Doxygen。下面是Doxygen的和DoC++一些鏈接：

Doxygen
Doc++

Answer 4

對於基於QT的C++項目也有qdoc。 http://doc-snapshot.qt-project.org/qdoc

Answer 5

我剛開始爲我的Python項目使用Sphinx。它的主頁聲明「C/C++已經被支持」。

它使用稱爲「reStructuredText」的輕量級標記。

我剛剛開始將它用於我的Python項目，並且非常喜歡輸出的外觀。