Qt文檔註釋文檔？ Qt + Doxygen？

我在哪裏可以找到Qt文檔註釋的文檔？我指的是Qt的是如何使用特定風格的文檔註釋，像這樣：Qt文檔註釋文檔？ Qt + Doxygen？

/*! 
    \class MyClassName 
    \brief The MyClassName class is used as an example on Stack Overflow. 

    This class serves a few functions, the most important being: 

    \list 
     \i So people can understand my question. 
     \i So people can have a few laughs at the comedy in my example. 
    \endlist 
*/

...你的圖片。那麼我在哪裏可以找到有關所有開關的信息，如\ class，\ list，\ brief等。另外，我使用哪些工具從源文件中的這些註釋生成文檔文件？ Doxygen是否支持這種語法？

來源

2010-06-17 Jake Petroules

請勿使用qdoc。 It is deprecated。無論如何，請使用基於qdoc的Doxygen。

也就是說，文檔（以qdoc格式：-D）是here。

來源

2010-06-17 05:35:01 sml

我一直在尋找的http：//qt.gitorious .org/qt/pages/DocManual和http://qt.gitorious.org/qt/pages/DocMarkupCommands。不知道它叫什麼（qdoc，呃？），我無法谷歌它。許多鏈接似乎已經死亡 – 2010-06-17 16:43:44

現在，你是說不推薦使用qdoc * tool *，或者整個qdoc *語法*（包括工具）已被棄用？諾基亞僅在Qt中使用qdoc語法，是爲了向後兼容，還是應該使用不同的樣式（如Javadoc註釋）來代替？顯然這取決於程序員，但我想保持與Qt的其他部分或諾基亞推薦的任何內容一致。 – 2010-06-17 16:49:12

感謝您的信息，這讓我省了很多時間。我正在爲qdoc3 ...傻瓜！ – karlphillip 2011-12-02 20:13:41

你可以看看Qt的源代碼本身的Qt文檔評論...

Qt - SRC - 4.6.3

我用的Doxygen的文檔，對我來說工作正常，雖然文檔標準不是Qt。我建議你儘量試一試並決定。

來源

2010-06-17 05:31:49 liaK

使用Doxygen的創建文檔

它可以產生一個在線文檔瀏覽器（HTML中）和/或從一組記錄的源文件的離線參考手冊（膠乳）。還支持在RTF（MS-Word），PostScript，超鏈接PDF，壓縮HTML和Unix手冊頁中生成輸出。文檔直接從源代碼中提取，這使得文檔與源代碼保持一致變得更加容易。

您可以配置doxygen以從未公開的源文件中提取代碼結構。這對於在大型源代碼分發中快速找到自己的方式非常有用。您還可以通過包含依賴圖，繼承圖和協作圖來自動生成各種元素之間的關係。

http://www.stack.nl/~dimitri/doxygen/

來源

2010-06-17 07:36:37 Pardeep

有Doxygen的兩個部分是QT-特定：所述Qt的註釋風格和QT_AUTOBRIEF的Doxyfile配置標記。這些只是QT使用的doxygen的一部分。所有由QT使用的doxygen評論都是普通的doxygen內容。所以你只需要閱讀doxygen。

或許是你真正需要的QT內部的文件，如d，指針信息包含在this blog entry

Qt樣式評論： 的\ *！文字*/評論風格被稱爲doxgyen評論的「Qt風格」。「！」將整個註釋塊標記爲doxygen註釋塊。它是Doxygen的標準選擇部分。

QT_AUTOBRIEF設置： 如果「QT_AUTOBRIEF」標籤設置爲True的Doxyfile，一個Qt風格的註釋塊的第一行會自動解釋爲\簡要說明。

從doygen GUI幫助：

QT_AUTOBRIEF標籤設置爲YES 然後使用Doxygen將詮釋一個 Qt的風格註釋的第一行（直到第一個點）作爲簡短描述。如果設置爲NO，意見的行爲就像普通的Qt風格的註釋（因此需要一個明確的 \簡短的命令簡短描述。）

來源

2010-07-01 22:10:11 sschilz

Qt文檔註釋文檔？ Qt + Doxygen？

回答

相關問題