0

我想让我的代码中的文档尽可能可读，但我也想用 Doxygen 自动生成文档。

然后我想用 Markdown 语法在我的代码中编写文档，但我没有找到如何在 Doxygen 中添加 Markdown 支持。

本页没有说明如何添加支持，并且 Doxyfile 中的 MARKDOWN_SUPPORT = YES 没有任何作用。

我正在使用 Ubuntu 12.04 和 Doxygen 1.7。

编辑 1：

  • “并保留原始文件扩展名”添加到标题

  • 我的问题来自我用于代码的扩展。我保留 .h 和 .cpp 扩展名，而 .md 是启用降价所必需的。是否可以使用降价并保留原始的 .h 和 .cpp 扩展名？

编辑 2：

  • 这是一个示例代码（test.h）：

    /**
* Title test
* ==========
* @file test.h
*
*   | This  | is     | a     | table |
*   | :----:| :----: | :----:| :----:|
*   | x     |   x    |    x  |   x   |
*/

    由于命令 @file，结果包括 Doxygen 中的文件，但生成的 html 文件将标题和表格显示为普通文本。

4

1 回答 1

3

我意识到我没有像最初想象的那样使用 Doxygen 1.8.5，而是使用 Doxygen 1.7。Doxygen 1.7（在 Ubuntu 存储库中提供）不会自动支持 Markdown，而 Doxygen 1.8.5 支持。

然后我不得不手动安装 Doxygen 1.8.5（这里是 64 位版本）并使用这个解决方案解决了安装问题。

Doxygen 现在原生支持 Markdown。

于 2013-11-15T09:25:54.640 回答