使用Doxygen在C++中記錄函數

Question

我有一個使用Doxygen生成文檔的項目。這些類的文檔很好，但我也有一些函數在main（）中用來創建對象等等。我也想把這些寫入我的文檔中，但我還沒有想到如何做到這一點。有什麼建議麼？

Answer 1

使用\fn在那裏你，否則 「在其他地方文檔」 使用\class在\\*!*\塊

http://www.doxygen.nl/docblocks.html
找

http://www.doxygen.nl/commands.html#cmdfn
它可以作爲記錄的成員函數

Answer 2

此相似模式對我們來說效果很好。

/*! Convert counts to kg for the reservoir. 
    \param counts The A/D counts to convert.` 
    \return The calculated kg based on the parameter. 
*/ 
float RES_ConvertCountsToValue(uint_16 counts); 

Answer 3

我喜歡這種模式

/////////////////////////////////////////////////////////////////////// 
    /// \brief setX 
    /// \param x offset of the image. 
    /// \return a new image as an QImage. 
    ///////////////////////////////////////////////////////////////////////// 
    QImage setX(int x); 

Answer 4

實體是類的成員，如果他們的類文件只記錄。在命名空間範圍聲明的實體只有記錄其名稱空間時才被記錄。在文件範圍聲明的實體僅在其文件被記錄時才被記錄。

所以記錄在全局命名空間的自由功能，您還需要這樣的地方在頭文件中聲明它的一行：

/** @file */ 

或者這樣：

/*! \file */