c++ - 如何使用 Doxygen 记录 C++ 函数中的局部变量

Question

比如在我的函数中

//starting code with doxygen documentation
/** The main function. I will now try to document variables within this main function*/
int main()
{
 int arr[]; /** \brief an integer array*/
 .....
 return 0;
}
//end of code

但是，当我在配置文件中将“HIDE_IN_BODY_DOCS”变量设置为“NO”的情况下使用 Doxygen 时，这不会执行此局部变量的特定文档。相反，它只是获取该位并将其与函数文档一起打印出来，就好像它是函数中的任何其他注释行一样

如何使用 Doxygen 记录此类局部变量？

Answer 1

我不知道有什么方法可以做到这一点(而且我怀疑是否存在这种方法)。请记住，doxygen 是用来记录类和函数头的，即接口(interface)。将文档视为其他程序员为了正确使用您的类和函数而学习的东西。你不应该使用 doxygen 来记录你的实现。但是，由于您使用 C(++) 进行编程，因此在源代码中记录局部变量应该不是问题。只需给它一个合适的名称或将其记录在“源代码中”:

猫猫[];//拿着一堆猫

在您定义所有变量的语言中，您必须在函数的开头声明(Delphi、Pascal)，但是您所要求的系统是有意义的。