Question

我想知道是否有办法将doxygen注释的特定部分从一个文件或多个文件复制到降价页面。下面我描述我想要做的事情。

我正在开发一个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文件链接到相应的注释也是可以接受的。

Answer 1

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

如果有人有更简单的方法来实现这一目标，那我就全都听见了。

doxygen将来自doxygen评论的特定数据复制到降价页面

1 个答案: