Doxygen 注释的“使用命名空间”

2024-03-29

我的库的所有类都是在命名空间内定义的。当我为 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"每次?


你可以让这个工作为一个命名空间将您的评论放入命名空间中。这让我很烦恼,因为我们有多个嵌套的命名空间,而且我讨厌在 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)

您可以看到渲染版本在线这里 https://realm.io/docs/xamarin/latest/api/

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Doxygen 注释的“使用命名空间” 的相关文章

  • 如何访问 Ruby 中的基本命名空间?

    我正在文件模块存在的命名空间中编写代码 在另一个模块内 我需要访问 ruby File 类 在 php 中可以这样完成 File 如何在红宝石中做到这一点 File 前缀为 访问命名空间树的 根
  • 覆盖父类中使用的类

    假设有一个类NiceClass使用其他类LesserClass在我无法编辑的地方 NiceClass py class LesserClass stuff class NiceClass Lots of use of lesser clas
  • 在 Visual Studio 调试器中查看命名空间全局变量?

    在 Visual Studio 2008 中调试非托管 C 项目时 我偶尔想查看全局变量的值 我们没有很多这些 但那些都在名为 全局 的名称空间中声明 例如 namespace global int foo bool bar 问题是 当代码
  • XSL:避免将命名空间定义导出到生成的 XML 文档

    我想从一些 XML 文件中获取数据并将它们转换为新的 XML 文档 但是 我不希望 XSLT 中命名空间的定义出现在结果文档中 换句话说 source
  • 为什么 Objective-C 没有命名空间?

    为什么 Objective C 没有命名空间 这似乎是一个简单的功能 可以使某些类名更具可读性 AVMutableVideoCompositionLayerInstruction有人吗 并删除类名上愚蠢的字母前缀 这主要是因为向后兼容吗 实
  • 忽略 doxygen 注释块中的行

    是否可以在 doxygen 注释块中包含将被 doxygen 忽略的内容 换句话说 我们可以在 doxygen 评论块中发表评论吗 背景 我们正在将 Fortran 项目的代码内注释转换为 doxygen 可解析的格式 但是该项目要求代码内
  • 枚举在类体之外但在命名空间内的定义

    今天 我遇到了一些类似这样的代码 namespace Foo public enum Game High Low public enum Switch On Off public class Bar Blah 我无法弄清楚这与在类中声明枚举
  • C# 命名空间是否编译为 IL 文件作为“完整”名称?

    例如 如果我有 namespace a namespace b class C class D 那么编译完成后 IL文件中的命名空间信息在哪里呢 我是否会得到两个名为 a b C 和 a b D 的类 其中类名以命名空间名称为前缀 或者我在
  • 匿名命名空间:它们真的那么好吗?

    我一直在使用static关键字时间较长 用于定义内部链接 后来 我改用 C 风格 将本地事物包装在匿名命名空间中 然而 现在当我使用匿名命名空间多年后 我开始认为static关键字更容易使用 一个常见的问题是我有这样的模式 namespac
  • 如何在 Django admin 中向第三方、外部 jQuery 插件提供 $

    我在 Django 管理基本模板中包含了几个第三方 jQuery 插件 这些插件假定 可用 对于我自己的代码 我一直很乐意这样做 function my code here django jQuery 但是我如何向外部文件中其他人的代码提供
  • 在 C# 中动态更改命名空间

    我想做这样的事情 如果定义了 DEBUG 则命名空间为 Test 或者命名空间为 TestB 请参阅下面的示例代码 我可以这样做吗 或者您有更好的想法来实现这一目标吗 提前致谢 if DEBUG SomekindofAttribute Na
  • SelectSingleNode 返回 null - 即使有命名空间

    我知道以前曾以类似的方式问过这个问题 但我似乎无法解决这个问题 我有一些 xml
  • 命名空间 + 函数与类上的静态方法

    假设我已经或将要编写一组相关函数 假设它们与数学相关 从组织上来说 我应该 编写这些函数并将它们放入我的MyMath命名空间并通过引用它们MyMath XYZ 创建一个名为MyMath并使这些方法静态并引用类似的MyMath XYZ 为什么
  • 为什么调用指定命名空间的函数会更慢?

    我认为指定我给出的命名空间R要做的工作更少 但我可能是错的 library microbenchmark gt microbenchmark unique default c 1 1 10 base unique default c 1 1
  • PHP CodeIgniter 框架中的命名空间

    CodeIgniter 支持命名空间吗 如何让命名空间在 Codeigniter 中工作 实际上 您可以让命名空间与应用程序模型中的相对路径结合使用 此修改使加载模型变得更加容易 并且还允许您拥有接口 将其添加到 application c
  • R:使用 devtools 自动将 import(data.table) 添加到 NAMESPACE

    如何正确添加import data table to the NAMESPACE自动使用文件devtools 一般来说 如果我的包使用data table我只是手动写入 但是无法使用 export and devtools document
  • JDOM、XPath 和命名空间交互

    我在使用 XPath 表达式从 JDOM 文档中提取一些元素时遇到了非常令人沮丧的情况 这是一个示例 XML 文档 我想从文档中完全删除 ItemCost 元素 但目前无法获取 XPath 表达式来计算任何内容
  • IIFE 和 call 的区别

    之间有区别吗 function call this and function or var MODULE function this hello world call MODULE and var MODULE function m m h
  • 有没有更快的方法将数字转换为名称?

    以下代码定义了映射到数字的名称序列 它的设计目的是获取一个号码并检索一个特定的名称 该类通过确保名称存在于其缓存中来进行操作 然后通过索引到其缓存中来返回名称 问题在这 如何在不存储缓存的情况下根据数字计算出名称 该名称可以被认为是一个以
  • C++ 使用命名空间来避免长路径

    我仍在学习 C 之前从未真正创建过自己的命名空间 我正在对它们进行试验 虽然我已经完成了大部分工作 但有一件事我似乎仍然无法做到 我希望能够在类中调用静态方法 而无需输入类似的内容NameOfClass method 我认为代码应该如下所示

随机推荐