Wysiwyg识字编程(或即时查看生成的文档)

时间:2010-09-09 14:07:47

标签: documentation eclipse-plugin doxygen documentation-generation literate-programming

我使用大量插图,图表和方程来记录C ++和python代码,并且这样做的方法是使用doxygen来内联它们。问题在于,在编码时,它们不能直接在代码中使用(除非我为此目的使用ascii-art)。

在编码时,是否有自动,快速,快速的方式查看生成的文档?例如,我可以有一个单独的Eclipse选项卡,其中包含已呈现的文档代码(HTML),而在另一个选项卡中进行编码...文档呈现选项卡将在我更改代码和文档时自动更新。

这可能吗?是否有用于Eclipse的工具,插件或用于Visual Studio的附加功能?

2 个答案:

答案 0 :(得分:3)

坦率地说,我使用第二台显示器(或第二台计算机)查看此类文档只是为了让它们不受阻碍 - 我希望在旁边看到它们我的Visual Studio屏幕不是< / strong>占用可能被代码占用的空间。

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

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

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

答案 1 :(得分:1)

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