程序员经验分享-hwhale

使用 Doxygen 自定义标签

2024-03-03

我想弄清楚是否有办法使用 Doxygen 创建自定义标签。我确实找到了 ALIAS 配置文件选项，但这并不完全符合我的需要。基本上在我的代码中我希望能够编写类似的内容

/// \req Requirement #322 - blah blah

然后让 Doxygen 创建一个列表，就像它所做的那样\bug and \todo具有此自定义标记的行的命令。 Doxygen 可以做到这一点吗？


的概括\bug and \todo is \xrefitem.

我建议的解决方案是：

  • 在 Doxyfile 中：

    ALIASES += "req=\xrefitem req \"Requirement\" \"Requirements\" "

  • 在记录的代码中：

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

Doxygen

使用 Doxygen 自定义标签 的相关文章

  • Doxygen使用教程（个人总结）

    简介Doxygen 一 xff0e 什么是Doxygen Doxygen 是一个程序的文件产生工具 xff0c 可将程序中的特定批注转换成为说明文件 通常我们在写程序时 xff0c 或多或少都会写上批注 xff0c 但是对于其它人而言 xf

  • 代码文档生成工具Doxygen教程及实例

    程序员的很多文档 xff0c 特别是有代码的文档 xff0c 绝大部分都是由一款文档生成工具 Doxygen 生成 什么是Doxygen Doxygen 是一个程序的文件产生工具 xff0c 可将程序中的特定批注转换成为说明文件 通常我们在

  • Doxygen + Graphviz 代码自动化分析

    Doxygen 43 Graphviz 代码自动化分析 目录 1 实际需求2 工具简介3 使用说明4 代码注释规范5 参考 1 实际需求 在开发程序时 xff0c 需要编写对应的说明文档 在阅读现有的项目源代码时 xff0c 需要梳理函数间

  • 工程代码模板注释及C规范

    工程代码模板注释规范 效果 使用方法以IAR为例 C代码规范 工程注释模板 C文件模板 h文件模板 函数注释 函数或变量命名方式 文件编码 对齐方式 优化 防御性编程 完成 Doxygen全套工具下载 效果 chm文件 网页效果 使用方法以

  • Doxygen 并将属性值添加到输出文档

    服务栈使用 C 属性标记 Web 服务的剩余路径 例如 RestService hello1 RestService hello2 public class Hello 我想让 Doxygen 在 Hello 类的 doxygen 输出中包

  • 使用 doxygen 扩展 makefile 以生成库和文档

    我已经实现了一个二叉树程序 其中包括带有函数的tree c 带有它们的声明的tree h以及用于测试的main c 另外 我有一个 makefile 它是 CC gcc CFLAGS g Wall DEPS tree h OBJ main

  • C++：生成函数调用树

    我想解析项目中当前的 C 文件并列出其中的所有方法 函数 然后生成函数调用和调用者树 F g 您可以参考 doxygen 如何生成调用树 我已经检查了 gccxml 但它没有列出从另一个函数调用的函数 请建议我一些我可以使用的轻量级工具 开

  • 混合 java/scala 项目自动生成的文档

    我希望获得一些有关如何最好地为混合 Java Scala 项目自动生成文档的建议 我们使用的是 Scala 2 8 2 8 1 附带的 scaladoc 工具似乎没有为我们的 Java 类生成可用的文档 它获得了正确的结构 但不包含文档 而

  • 使用 Doxygen 的 Qt 风格文档？ [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 如何使用 Doxygen 生成 Qt 风格的文档 Trolltech 的 C Qt 或 Riverba

  • 在 Objective-C 中，什么实用程序在注释中使用 @brief 标签？

    我刚刚开始使用 Objective C 编程 发现了一些示例注释 如下所示 brief The UIImageView we use to display the image generated from the imageBuffer 目

  • 在 doxygen 中记录 #undef 的好方法

    我目前在 c 文件中有几个 define 可以关闭硬件的某些功能以进行测试 但是 当它们未定义时 我想用 doxygen 记录它们 例如 这工作正常 def SIMULATE SOME HW INTERFACE Define this wh

  • 使用 Doxygen 记录命名空间

    我在 Doxygen 识别命名空间和模块时遇到问题 我认为问题在于是否将 addtogroup命名空间内或命名空间外 示例 1 在命名空间之外 addtogroup Records Generic record interfaces and

  • Doxygen 速度慢

    Doxygen 在我们的代码库上运行大约需要 12 小时 这主要是因为有大量代码需要处理 约 150 万行 然而 我们很快就无法进行夜间文档更新 因为它们花费的时间太长 我们已经不得不减少图表深度以将其缩短至 12 小时 我已经尝试过标准方

  • 如何在 Doxygen 注释中包含“<”？

    假设我正在使用 DOxygen Visual studio 兼容注释记录成员函数 如何使用小于 例如 如果我这样做

  • 在 doxygen 中使用模块组内的节

    我寻求构建 doxygen 模块组内容的首选方法 例如 我想在不同部分的以下模块组中构造 details 文本 特别是每个部分都应该出现在生成的 PDF 的书签中 作为模块组的子元素 defgroup lorem brief Lorem i

  • 如何排除私有标头出现在源浏览器中？

    我已经设定SOURCE BROWSER NO and VERBATIM HEADERS YES因为我希望客户端能够看到头文件 但是 我只想让他们看到某些标题 最好的方法是如何做到这一点 预先感谢您的任何帮助 EDIT 这似乎可行 但我对其他

  • 如何在 vim 下突出显示 doxygen 中的 markdown？

    较新版本的 doxygen 附带了 Markdown 支持 有没有一种简单的方法可以将 Markdown 语法突出显示添加到 vim 中的 doxygen 注释块 顺便说一句 可以将 doxygen 语法添加到c文件通过使用set file

  • 在 Doxygen 中引用参数的正确方法是什么？

    我有以下 Doxygen 函数文档 brief Does interesting things param in pfirst The first parameter a barrel full of monkeys pre pfirst

  • Doxygen 和 Objective-C 类别

    尽管 Doxygen 的最新版本声称可以更好地处理 Objective C 类别 http www doxygen nl manual changelog html 它似乎仍然对我的源代码中的类别感到窒息 我想知道是否有人已经让它正确地记录

  • 如何更改 graphviz 的默认字体大小？

    我使用 doxygen graphviz 来记录我的代码 graphviz 在生成图像方面做得很好 有什么方法可以更改 graphviz 的默认字体大小吗 默认值为 14 但我想使用 12 更改单个元素 例如节点 子图 边缘等 的字体大小确

随机推荐

  • 自定义设备控制器不工作

    我有两个模型居民和用户 它们都包含 roll number 属性 我现在已经在驻留模型中输入了数据 当用户注册哪个是 Devise 资源时 它会检查驻留模型中是否存在相同的 roll number 然后就可以注册用户了 所以基本上我向 De

  • 替换JS中某个字符的所有实例？

    我正在尝试创建一个简单的函数来替换 JS 中字符串中某个字符的所有实例 在这种情况下 我想替换所有a s with o s 我很确定代码是正确的 但输出仍然是原始字符串 function replaceLetter string for v

  • mongorestore 随机崩溃（致命错误）

    我使用的是 macOS 10 12 mongod version db version v3 2 8 git version ed70e33130c977bda0024c125b56d159573dbaf0 OpenSSL version

  • 如何在源代码中查找搜索词

    我正在寻找一种在项目的 C C 代码中搜索给定术语的方法 同时忽略注释和字符串中出现的任何情况 由于代码库相当大 我正在寻找一种方法自动地识别与我的搜索词匹配的代码行 因为它们需要手动检查 如果可能的话 我想在我的 Linux 系统上执行搜

  • 绘制相同值时显示更大的点

    当我绘制以下示例时 Participant lt c 1 12 AnswersDay1 lt c 9 3 9 13 7 12 10 7 9 0 12 11 Day1Group lt c 0 1 0 1 0 1 0 1 0 1 0 1 Pus

  • 傅立叶空间中的滤波器的行为与预期不同

    这是我提出的已回答问题的后续内容 可以找到here https stackoverflow com questions 54022376 inverse fft returns negative values when it should

  • RDP(VM) 最小化时自动化脚本失败

    我一直面临着在其中一台虚拟机上自动执行脚本的问题 我已经实现了保存文档功能的自动化 该功能最好是 Windows 设计的 UI 我尝试过使用各种技术 工具 如 AutoIT Python Sikuli 但如果虚拟机最小化 脚本就会停止 如果

  • 使用 Savon 在 Ruby on Rails 中进行 SOAP 调用在信封和主要操作方面变得很奇怪

    在使用 Savon rb 的 Rails 项目中 我尝试进行非常复杂的 SOAP 调用 至少复杂到 Savon 构建者太麻烦了 所以我决定直接操作 xml 首先我启动客户端 client Savon client endpoint gt h

  • 有 XHTML 5 验证器吗？

    是否有专门针对 XHTML 5 的验证器 即 HTML 5 的 XML 序列化 这W3C 验证器 http validator w3 org 支持文档类型 HTML 5 experimental which treats as valid

  • 从第二次“应用内购买”开始在 Android 中抛出异常

    我正在尝试包含在应用程序购买中 并且已成功显示可用的 SKU 现在我想进行虚假购买 所以我使用了 appId android test purchased 第一次它工作完美 但从接下来它抛出异常 如下所示 尝试在空对象引用上调用虚拟方法 a

  • 为什么主键顺序很重要？

    我最近在 EntityFramework 项目中设置了一个类 它将其几个成员指定为组合键 但是 当需要从中创建数据库时 它给出了错误 无法确定类型 NNNNN 的复合主键排序 使用 ColumnAttribute 或 HasKey 方法指定

  • 如何对异常处理程序中间件进行单元测试

    我正在尝试使用自定义错误处理程序为我的 NET Core 3 API 返回格式正确的异常 处理程序工作得很好 我遇到的问题是编写适当的单元测试来测试处理程序 我为此注册了中间件 如下所示 public void Configure IApp

  • 如何使用 Angular 2(typescript) 将数据和图像传递到“ASP.NET Core”Web API？

    我有只能将数据传递到 Web API 的代码 但我想将数据和图像都传递到同样的要求不在使用 Angular 2 TypeScript 和 ASP Net Core Web API 的不同请求中 我的将数据传递给API的代码 角度代码 cre

  • 合并 2 个或更多 ELF 文件的最简单方法

    我正在为一个类项目编写一些嵌入式代码 该项目当前 根据要求 创建了许多 srec 文件并合并它们 我希望能够将此代码加载到 QEMU 中 但它通常只对 ELF 文件满意 合并原始 ELF 文件而不是 srecs 的最有效方法是什么 同样可以

  • jQuery Datatables 在列中插入字段值

    我有一个 jQuery 数据表插件 它执行以下操作 tr th Id th th Datee th th Delete th tr data dataTable bProcessing true bServerSide true sAjax

  • 为了实现快速读/写性能（在 Python/pandas 中），推荐的 HDF5 压缩是多少？

    我曾多次读到 在 HDF5 中打开压缩可以带来更好的读 写性能 我想知道什么理想的设置可以在以下位置实现良好的读 写性能 data df to hdf format fixed complib complevel chunksize 我已经

  • 双三次插值 - Matlab 到 C++

    我正在尝试实现双三次插值 这是我的问题的后续问题 MATLAB vs C vs OpenCV imresize https stackoverflow com questions 26812289 matlab vs c vs opencv

  • 热重载不适用于 webpack-dev-server 和 docker

    使用安装了 docker 的 Ubuntu Linux 没有虚拟机 我已经使用 vuejs 应用程序构建了一个 docker 映像 为了启用热重载 我使用以下命令启动 docker 容器 docker run it p 8081 8080

  • LuaJIT 支持表的 __gc 吗？

    Lua 5 2 与 5 1 相比 支持表的 gc LuaJIT 借用了这个好功能吗 我进行了谷歌搜索 并检查了 LuaJIT变更历史记录 http luajit org changes html但无法找出答案 去尝试一下 test lua

  • 使用 Doxygen 自定义标签

    我想弄清楚是否有办法使用 Doxygen 创建自定义标签 我确实找到了 ALIAS 配置文件选项 但这并不完全符合我的需要 基本上在我的代码中我希望能够编写类似的内容 req Requirement 322 blah blah 然后让 Do

热门标签