我有一个项目,我正在使用 Doxygen 为其生成文档。类的文档很好,但我也有一些用于创建对象等的非成员函数。我也希望将这些记录在案,但无论我尝试什么,Doxygen 都不会生成文档我放在函数上方的评论。为什么 Doxygen 不会为全局命名空间中的函数生成文档,我需要做什么才能让它工作?
最佳答案
作为类成员的实体只有在其类被记录时才会被记录。在命名空间范围内声明的实体只有在它们的命名空间被记录时才会被记录。在文件范围内声明的实体仅被记录 if their file is documented .
因此,要在全局命名空间中记录一个自由函数,您还需要在声明它的头文件中的某处有这样一行:
/** @file */
或者像这样:
/*! \file */
关于c++ - 使用 Doxygen 在 C++ 中记录函数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/2794054/