0

I use a lot of illustrations, diagrams and equations to document C++ and python codes, and a way to do this is to inline them with doxygen. The problem is that, when coding, they are not directly available in the code (unless I use ascii-art for this purpose).

Is there an automatic, quick and fast way to, while coding, view the generated documentation? E.g., I could have a separate Eclipse tab with the rendered documented code (HTML), while coding in another tab... and the documentation rendering tab would be updating automatically as I change the code and the documentation.

Is this possible? Is there a tool, plug-in for Eclipse or add-on for Visual Studio enabling this?

4

2 回答 2

3

坦率地说，我使用第二台显示器（或第二台计算机）来查看此类文档，只是为了让它们不碍事——我希望在我的 Visual Studio 屏幕旁边看到它们，而不占用可能被代码占用的空间。

我将生成的 Doxygen 文档发布到内部 Web 服务器，因此如果您有 HTML 查看器插件，您可以将其指向它。（我通常会在旁边打开一个浏览器）。

您可以将 Doxygen 项目设置为直接生成到 Web 服务器目录中，这样就没有复制时间来更新它。

一个提示，如果你有一个大的代码库并且 Doxygen 需要很长的时间，那就是有一个特殊的设置文件只指向你正在处理的代码，以快速重新生成相关的几个页面。如果文件发生更改，您可以使用 python 脚本观察目录并重新运行 Doxygen。

于 2010-09-10T03:11:01.427 回答
1

试试我的 LP 工具 - http://code.google.com/p/nano-lp - 它支持 OpenOffice/LibreOffice，因此您可以以所见即所得的方式编写 LP 程序。顺便说一句，如果您决定使用标记语言而不是 OpenOffice，NanoLP 支持其中的几种。

于 2013-01-24T06:56:51.000 回答