1

有没有免费的像样的程序来为java编写代码文档？完成编码项目已经够难了，然后还需要花时间编写文档。如果你知道，请告诉我。

4

6 回答 6

16

javadoc是 Java 源代码文档的标准工具（包含在 JDK 中）。

标准 Java API 文档是使用 javadoc 生成的。

于 2009-09-30T11:34:46.547 回答
3

出色地，

肯定有javadoc。我认为它是迄今为止记录 java 项目最常用的工具。此外，请考虑到不仅记录方法和类，而且您还可以使用静态 html 页面记录/创建教程，它们将出现在生成的文档中。

于 2009-09-30T11:36:58.173 回答
1

Javadoc（如前所述）是 Java 的标准工具。但是，您可能想查看Doxygen，它将提供更强大的代码导航功能和渲染选项。

于 2009-09-30T11:37:36.870 回答
1

所有最流行的 IDE（例如 Eclipse、NetBeans）都会为您生成 javadocs。它会列出所有参数、抛出的异常等。对于像 getter 和 setter 这样的明显目的的方法，它也会生成足够好的注释（getX() "Gets x" 等）。您需要做的不仅仅是完成对比 getter、setter 或默认构造函数更复杂的类和方法的 javadoc 注释。

还有很多插件（对于 Eclipse，请参见此处），例如，您可以使用它们来生成 UML 图来说明您的代码结构。

于 2009-09-30T12:05:00.293 回答
0

多年来（十多年），我使用 TallTree 的 DocJet ( http://www.talltree.com/ ) 从我的 Java/C++ 代码生成技术文档，结果非常令人满意。该工具不需要任何特殊标签（尽管它可以理解 javadoc 标签）；用简单的英语描述类/方法/字段就足够了，偶尔会出现“return”（或任何其他具有相同含义的表达）、“parameter”或“argument”等措辞。

于 2009-11-30T14:42:36.987 回答
0

自动生成的文档很糟糕。为什么有它？它没有增加任何价值。

于 2009-09-30T11:44:35.623 回答