C++中的文檔字符串工具

像Python，MATLAB，E-Lisp這樣的語言對於文檔字符串有很好的功能。通過此功能，只需在終端中使用幾個按鍵，就可以獲取已寫入和導入到代碼中的函數/模塊的文檔。C++中的文檔字符串工具

現在是沒有任何「技術」（圖書館，編輯技巧，無論於）在 C++/C。得到類似的設施假設我包括源文件中的函數的文檔在函數的頭，然後我想在終端鍵入一個像getinfo這樣的命令。（就像一個手冊頁）

我知道很多C函數都存在這樣的'man'工具，但是這些函數的文檔都是用獨立的文本文件從源代碼中寫入的。我希望文檔就位

來源

2012-05-28 smilingbuddha

Doxygen和類似的東西？ – Fanael

是的，但與Doxygen，我不認爲可以從終端提取文件。我想要一個基於終端的設施。用Doxygen我需要在網頁瀏覽器中打開文檔。或者也許Doxygen已經有這個設施了？ – smilingbuddha

Doxygen [可以生成manpage]（http://www.stack.nl/~dimitri/doxygen/starting.html#man_out）。 – Fanael

您可以使用類似Doxygen之類的東西。它支持生成man pages等格式。

來源

2012-05-28 15:31:25 Fanael

如果您使用類似於Javadoc的語法在註釋中註釋了代碼，則可以使用Doxygen爲您的代碼生成各種不同格式的文檔。它可以生成手冊頁等，但似乎人們使用的首選輸出格式是HTML頁面。

來源

2012-05-28 15:29:06 lvella

Visual Studio可以/將生成包含從DocXml格式化的註釋中提取的信息的彈出窗口。您必須編譯/doc，這將從註釋中提取XML到.xdc文件。然後，您必須運行xdcmake將.xdc文件編譯爲xml文件。你通常會在構建過程中自動處理所有這些，所以你不必手動做很多事情（當然，除了寫評論本身）。然而，要記住的一點是，代碼（至少是聲明）必須在獲得彈出窗口之前構建。

我覺得有必要補充說IMO，大多數這樣的評論通常都很接近無用。如果企業標準使他們不可避免，那就這樣做 - 但是如果他們誠實地提供任何有用的信息，我會認爲這是一個問題的表示（「代碼氣味」，如果你更喜歡這種措辭）。在大多數情況下，功能的名稱（或其他）和參數的名稱/類型的組合應使使用該功能非常清楚。

來源

2012-05-28 16:54:06

C++中的文檔字符串工具

回答

相關問題