在 Doxygen 中记录命名空间

Question

我开始用 doxygen 记录我的所有代码。我对文件文档没问题，但在为多个文件生成文档时遇到了一个小问题。

例如：

在一些头文件中（我只使用 C/C++ 代码项目）我有以下代码：

#include "../config/compiler.h"  ///< Compiler flags

namespace nge                    ///< NGE namespace
{
... some code...
}

在运行 doxywizard 之后，如果我查找命名空间的文档，我将看到 NGE 命名空间，但不会得到：

NGE | NGE namespace

我明白了

NGE | Compiler flags

即使我将 /// NGE namespace 与 /// @namespace NGE namespace

交换也会出现这种情况

谁能帮我解释一下我哪里出错了？？

Answer 1

"Compiler flags" 的问题确实是 #include 无法记录，评论（包括 <）流入下一项的简要描述（即 namespace NGE). namespace NGE 的文档也有额外的 < 是因为 ///< 用于在完整项目之后进行记录，在这种情况下是名称空间的定义还没有完成。

在 Doxygen 中记录命名空间

Documenting namepaces in Doxygen

c++

doxygen

doxygen-wizard