0

我想知道是否有办法将 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 下面的评论让我想了更多。如上所述的解决方案是首选，但我认为即使我可以从降价文件链接到相应的评论也是可以接受的。

4

1 回答 1

0

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

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

于 2013-10-18T00:21:07.217 回答