c++ - 使用 Doxygen 在 C++ 中记录函数

Question

我有一个项目，我正在使用 Doxygen 为其生成文档。类的文档很好，但我也有一些用于创建对象等的非成员函数。我也希望将这些记录在案，但无论我尝试什么，Doxygen 都不会生成文档我放在函数上方的评论。为什么 Doxygen 不会为全局命名空间中的函数生成文档，我需要做什么才能让它工作？

Answer 1

只有在记录了它们的类时，才会记录作为类成员的实体。在命名空间范围内声明的实体只有在它们的命名空间被记录时才会被记录。在文件范围内声明的实体只有在它们的文件被记录时才会被记录。

因此，要在全局命名空间中记录一个自由函数，您还需要在头文件中声明它的某处这样的行：

/** @file */

或者像这样：

/*! \file */

Answer 2

使用\fn你\class在你的\\*! *\块中使用的地方

http://www.doxygen.nl/manual/docblocks.html 寻找“其他地方的文档”

http://www.doxygen.nl/manual/commands.html#cmdfn
它的工作方式类似于记录成员函数

Answer 3

这种模式对我们很有效。

/*! 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 4

我喜欢这个图案

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