Doxygen中的所见即所得

Question

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

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

有没有办法将WYSIWYG的大块文件转换成doxygen？我觉得这会提高记录代码的人数以及文档的质量。我考虑链接到HTML，但是这分开了文档。我也考虑过把它们内联在html中，但这看起来也很痛苦，意味着每个人都需要一个所见即所得的HTML编辑器（或者一些html技巧）。

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

谢谢加载。

Answer 1

我建议在HTML中打印Word文档。 Doxygen可以包含HTML文档或至少可以接受评论和描述中的HTML语法。

Answer 2

您可以在您的评论中放入<pre> ... </pre>部分，并操纵一点点.css，您可以根据自己的喜好对其进行格式化。

Answer 3

我的加载项，Atomineer Pro Documentation可能会有所帮助。

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

所以，很抱歉，这不是对您的问题的直接解决方案 - 但它可以帮助您通过嵌入式doxygen注释帮助您的团队更好，更高效地工作。