如何从c++项目生成markdown文档?

问题描述 投票:0回答:2

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

为此,我开始使用 Doxygen,它适合我的使用,因为我只需注释项目的标题即可获取完整的 HTML 文档。该文档运行良好并且风格良好。

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

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

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

我知道 Markdown 语法很简单,但我无法自己编写整个 Markdown,因为该项目很大并且会经常更新,所以我需要一个通用方法来从 C++ 项目获取 Markdown 中的文档。

markdown doxygen
2个回答
1
投票

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

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

tex
文件。某些转换程序不接受分割
tex
文件。

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


0
投票

Markdown 支持在 Doxygen 版本 1.8.0 中引入。

© www.soinside.com 2019 - 2024. All rights reserved.