namespaces - "using namespace"用于 Doxygen 评论

Question

我的库的所有类都在一个命名空间中定义。当我为 Doxygen 创建主页时，我必须在注释中明确使用这个命名空间来让 Doxygen 生成链接。我想对整个注释块使用“使用命名空间”之类的东西。

一个例子:

/**
* \mainpage My Library
*
* Use MyLibraryNamespace::MyClass to ...
*/

这里 Doxygen 自动生成一个链接到 MyLibraryNamespace::MyClass 的文档。

/**
* \mainpage My Library
*
* Use MyClass to ...
*/

此处 Doxygen 不会生成指向 MyLibraryNamespace::MyClass 文档的链接(因为我认为在不同的命名空间中可能有多个 MyClass 定义)。为了便于阅读，我想在注释中省略命名空间前缀。是否可以不用输入 \ref MyLibraryNamespace::MyClass "MyClass"每次？

Answer 1

您可以为 进行这项工作一个命名空间 通过将您的评论放在命名空间中。由于我们有多个嵌套的命名空间，我讨厌在 Doxygen 注释中使用它们，这让我很不舒服。

namespace MyLibraryNamespace {
/**
* \mainpage My Library
*
* Use MyClass to ...
*/
};

Markdown 视角的 2016 年更新

我将 Doxygen 用于 Realm 的 C# 文档(是的，Doxygen 也处理典型的 C# XML 注释格式!)。 Markdown 主页使用 @ref 来引用命名空间类:

The main classes you will use are:

- [Realm](@ref Realms.Realm)
- [RealmObject](@ref Realms.RealmObject)
- [RealmList](@ref Realms.RealmList)
- [Transaction](@ref Realms.Transaction)

您可以看到渲染版本 online here