如何从 C++ 项目生成降价文档?

How to generate markdown documentation from c++ project?

我正在尝试为复杂的 C++ 项目创建文档。

为此,我开始使用适合我使用的 Doxygen,因为我只需要评论我项目的 headers 即可在 HTML 中获得完整的文档。中的这份文档工作得很好,风格也很好。

但这是我的问题,我想在 Markdown 文件中获取此文档,以便能够将其推送到 Gitlab。

我尝试使用 moxygen 将 xml 文件转换为 md 文件。它工作但不如我想要的那样正确:moxygen 自动生成的锚点不工作。演示文稿也是一个问题,例如它将定义列表放在文件的顶部,这很长而且在文档中不是最有用的。

我想知道是否有一种方法可以像使用 Doxygen 一样简单地记录我的代码,但获得适当的降价文件(锚点工作和更好的模板)。

我知道 markdown 语法很简单但是我不能自己写整个 markdown 因为项目很大而且会经常更新所以我需要一个通用的方法来从 C++ 项目中获取 markdown 文档.

我运行前段时间也遇到过类似的问题,一直不好解决。基本上我所做的是将文档转换为 LaTeX,然后从那里转换为 markdown。检查 this 到 LaTeX->Markdown 段落(其他工具也存在)。

您可以在某种程度上使用 make/latexmke 自动执行该过程,但我个人无法使该过程变得简单,有时我仍然需要介入。另请注意,您可能需要使用其他工具(如 flex)将您的 LaTeX 文档制作成一个大 tex 文件。某些转换程序不接受拆分 tex 个文件。

这并不完美,但它可能会给你另一个角度。希望对你有帮助。