在 Doxygen 中记录命名空间答案

【问题标题】：Documenting namepaces in Doxygen在 Doxygen 中记录命名空间
【发布时间】：2020-04-20 00:36:20
【问题描述】：

我开始用 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 交换也会发生这种情况

有人请解释一下我在哪里犯了错误？？

【问题讨论】：

您使用的是哪个版本的 doxygen？据我所知，#include 不能记录在 doxygen 中，doxygen 会将这个文档保存在“内存中”并将其添加到它找到的下一个项目中。
我的 doxygen 版本是 1.8.16 for Windows x86

【解决方案1】：

“编译器标志”的问题确实是无法记录#include，并且注释（包括<）流入下一项的简要描述（即namespace NGE）。 namespace NGE 的文档也有额外的 < 的事实是因为 ///< 用于在完整的项目之后进行记录，在这种情况下，命名空间的定义还没有完成。

【讨论】：