有没有一种简单的方法来生成eclipse的文档而不会打扰代码?

时间:2012-04-24 05:27:48

标签: java eclipse documentation

我必须生成一份关于我所有程序的类和方法的报告,并将其放入word文档中。现在,我真的想知道是否有一个软件可以从我的项目文件生成文本文件文档,而无需在源代码中插入注释。我只想要一个text或ms word文件中所有方法和类的列表,以便我可以自己填写说明。

3 个答案:

答案 0 :(得分:4)

可以仅使用未注释的源代码生成javadoc文档。它将生成HTML,但可能有Word转换器。

但是,我强烈建议您在代码中添加注释。这是全世界Java程序员所期待的;当您将新代码调用到当前API时,文档将显示在工具提示中;工具正在为它做好准备。基本上,尝试使用语言约定而不是与它们作斗争。

编辑:听起来您可以使用doclet为您生成Word文档。 MIF Doclet可能是一个很好的起点,或PDFDoclet

答案 1 :(得分:1)

使用javadoc生成文档,然后将其转换为所需的格式。在这里寻找不同的选择。 http://java.sun.com/j2se/javadoc/faq/index.html#print

希望它有所帮助。

答案 2 :(得分:0)

有一个Maven插件,“maven-site-plugin”可用于从Java项目生成可编辑的HTML文档。