Doxygen 中的所见即所得

Question

我正在从事一个用 C 语言编写的相当大的项目。我的想法是构建一个可以跨多个平台重用的模块化模块库。每个模块都与 .docx 格式的 word 文档相关联（差异合并非常痛苦）。在这些文档中，指定了一个接口部分，列出了数据类型和可公开访问的函数。这些通常与代码中的实际实现不一致，并且翻阅所有这些文档很痛苦。

我一直在努力改用 doxygen 来简化文档管理。我还没有找到将之前编写的文档嵌入到 doxygen 输出中的好方法。我已将它们复制粘贴到部分中并使用模块将源分组在一起，但文档部分在 cmets 中看起来很难看（输出很漂亮），并且由于 doxygen 需要一段时间来解析我们的代码（大约 30 分钟），验证格式很痛苦。

有什么方法可以将大块的文档所见即所得的数据转换成 doxygen？我觉得这会提高记录代码的人数以及文档的质量。我考虑过链接到 html，但这会拆分文档。我还考虑将它们内联到 html 中，但这似乎也很痛苦，意味着每个人都需要一个所见即所得的 HTML 编辑器（或一些 html 技能）。

关于如何让事情变得更简单和更漂亮的任何想法？

感谢负载。

Answer 1

我建议以 HTML 格式打印 word 文档。 Doxygen 可以包含 HTML 文档，或者至少可以在 cmets 和描述中接受 HTML 语法。

Answer 2

我的插件Atomineer Pro Documentation 可能会有所帮助。

它还没有（还）提供所见即所得，但它确实有助于 Doxygen 或 DocXML 文档 cmets 的日常管理和更新，这有助于使它们与代码保持同步并以最小的努力保持整洁/可读 -这通常会导致程序员实际记录东西，因为麻烦因素被最小化了。

所以，很抱歉，这不是您问题的直接解决方案 - 但它可以帮助您使用嵌入式 doxygen cmets 让您的团队更好、更高效地工作。

Answer 3

您可以将<pre> ... </pre> 部分放在您的 cmets 中，并通过一点点操作 .css 您可以根据自己的喜好对其进行格式化。