doxygen 将 doxygen 评论中的特定数据复制到降价页面答案

【问题标题】：doxygen copy specific data from doxygen comments into markdown pagedoxygen 将 doxygen 评论中的特定数据复制到降价页面
【发布时间】：2012-11-18 15:03:16
【问题描述】：

我想知道是否有一种方法可以将 doxygen cmets 的特定部分从一个文件或多个文件复制到降价页面中。下面我描述了我正在尝试做的事情。

我正在开发一个 C++ 插件代码，它由几个模块组成。每个模块都遵循其版本编号方案。在每个插件版本中，我为每个模块选择一个特定的版本号。为了让最终用户以编程方式访问这些信息，我设置了一个namespace，如下所示：

namespace VersionInfo {
    string getModuleA_Version() { return "2.3"; }
    string getModuleB_Version() { return "1.0"; }
    string getPlugin_Version() { return "10.11"; }
}

我还希望此信息出现在 README.md 降价文件中。 doxygen 是否可以，如果可以，我应该如何评论上面的 C++ 代码和README.md 文件？

如果我必须在 C++ 注释中再次写入版本号，我可以。例如：

// Sample pseudo-code
/**
  * @brief version number for module A.
  * @version_moduleA 2.3
  */
string getModuleA_Version() { return "2.3"; }

是否可以如上所述定义自定义变量，然后在markdown文件中引用它们？例如，类似：

// Sample pseudo-markdown
Versions
- ModuleA : @version_moduleA
- ModuleB : @version_moduleB
- ModuleC : @version_moduleC

我尝试过浏览 doxygen 主页上的文档，但我无法弄清楚。

即使您指出 doxygen 命令也会有所帮助，我会尝试从那里解决。

编辑 @Zane 下面的评论让我想了更多。如上所述的解决方案是首选，但我认为即使我可以将 markdown 文件中的 link 链接到相应的注释，也是可以接受的。

【问题讨论】：

您可以使用 @snippet 从源文件中引用，但 afaik 这不适用于降价。降价真的有必要吗？
@Zane 降价页面README.md 包含与插件相关的其他一些信息（依赖项、安装等），所以我认为将这些信息也放在那里会很好。我可以处理从降价页面中排除的数据，或者手动从 C++ 文件中复制数据，但我认为如果自动完成，出错的可能性会降低。

标签： c++ markdown doxygen

【解决方案1】：

我需要解决将源代码cmets插入markdown文件的相同问题。我的计划是让 doxygen 输出 xml 并将我自己的自定义标签放在降价文件中（如 @xml_brief_description ）。然后编写一个解析 XML 文件并在 markdown 文件中进行适当替换的后处理脚本。

如果有人有更简单的方法来实现这一点，那么我会全力以赴。

【讨论】：