文档java代码

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

是JDK for java源代码文档中包含的标准工具

已使用javadoc生成。

是JDKforJava源代码文档中包含的标准工具

已经用javadoc生成了

当然有。我认为它是迄今为止最常用的记录java项目的工具。另外，要考虑到不仅要记录方法和类，还可以记录/创建带有静态html页面的教程，它们将出现在生成的文档中。

---

当然有。我认为它是迄今为止最常用的记录java项目的工具。另外，考虑到不仅要记录方法和类，还可以记录/创建带有静态html页面的教程，它们将出现在生成的文档中。

Javadoc是Java的标准工具。但是，您可能希望签出，它将提供更强大的代码导航功能和呈现选项。

Javadoc是Java的标准工具。但是，您可能希望签出，这将提供更强大的代码导航功能和呈现选项。

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

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

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

---

Eclipse还有很多插件，例如，您可以使用这些插件生成UML图来说明您的代码结构。

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

---

Eclipse还有很多插件，例如，您可以使用它们生成UML图来说明您的代码结构。

十多年来，我一直在使用TallTree的DocJet从我的Java/C++代码生成技术文档，结果非常令人满意。该工具不需要任何特殊的标记，尽管它理解javadoc标记；仅用简单的英语描述类/方法/字段就足够了，偶尔还会用到诸如“return”或具有相同含义、参数或参数等的任何其他表达式。

十多年来，我一直在使用TallTree的DocJet从我的Java/C++代码生成技术文档，结果非常令人满意。该工具不需要任何特殊的标记，尽管它理解javadoc标记；用简单的英语描述类/方法/字段，偶尔使用“return”或其他具有相同含义、参数或参数等的表达式就足够了。

你是说javadoc不体面吗？你说得体是什么意思？请提供一些有用的定义，以便于得体。大多数答案指向javadoc，一旦您生成javadoc注释，它将呈现您的文档。然而，关于javadoc注释生成的问题不是吗？我会说：javadoc是不体面的。虽然注释一旦被编译可能会很有用，但它们的源格式实际上是不可读的。使用html子集的决定是令人讨厌的。更像wiki的东西，甚至这里使用的标记都会更好。@CPerkins:有趣的观点。太糟糕了，提问者没有更新问题来定义体面。也许他们根本就没有询问markup at all.OP，如果您在IntelliJ IDEA free中的方法/类上键入/**即使是用于商业用途并按Enter键，它会将其转换为包含参数的完整Javadoc存根，您只需添加一些文本，当然，它允许您在以后将项目的所有javadoc转换为良好的旧HTML文件结构，这样您就有了一个可以浏览的外部版本？你说得体是什么意思？请提供一些有用的定义，以便于得体。大多数答案指向javadoc，一旦您生成javadoc注释，它将呈现您的文档。然而，问题不在于

---

javadoc注释生成？我要说的是：javadoc是不体面的。虽然注释一旦被编译可能会很有用，但它们的源格式实际上是不可读的。使用html子集的决定是令人讨厌的。更像wiki的东西，甚至这里使用的标记都会更好。@CPerkins:有趣的观点。太糟糕了，提问者没有更新问题来定义体面。也许他们根本就没有询问markup at all.OP，如果您在IntelliJ IDEA free中的方法/类上键入/**即使是用于商业用途并按Enter键，它会将其转换为包含参数的完整Javadoc存根，您只需添加一些文本，当然，它允许您在以后将项目的所有javadoc转换为良好的旧HTML文件结构，这样您就有了一个可以浏览的外部版本。请注意，javadoc通过javadoc工具的doclets插件具有高度的可定制性和可扩展性。请看@all downvoter：请务必给出你的否决理由。它会帮助别人。事实上，我觉得这个答案对作者没有多大帮助，但我认为埃里克伦是唯一一个理解这个问题的人。对我来说，Gingeek希望自动生成javadocs，而不仅仅是渲染。你被否决了，因为你的答案没有帮助，也不是这个问题的有用答案。此外，计算机永远无法自动生成文档，因为计算机无法用人类语言为您描述类或方法是什么。你必须自己写。许多IDE帮助你在类、方法等上添加空的javadoc块@Jesper:所以你同意erikkallen的答案，但你还是因为答案的形式和缺乏解释而让他失望。事实上，这对我来说是公平的。对于需要生成x公斤文档的OP来说，这可能没有什么用处，但对于阅读此线程的其他人来说，这可能会有所帮助。我们有一个专门使用自动生成文档的编码员。。。。我讨厌看到/**设置用户名*/public void setUserName。。。让评论对我低声下气，却不提供任何有用的信息，这是没有用的，也是令人愤怒的。@all downvoter:请务必给出你的否决理由。它会帮助别人。事实上，我觉得这个答案对作者没有多大帮助，但我认为埃里克伦是唯一一个理解这个问题的人。对我来说，Gingeek希望自动生成javadocs，而不仅仅是渲染。你被否决了，因为你的答案没有帮助，也不是这个问题的有用答案。此外，计算机永远无法自动生成文档，因为计算机无法用人类语言为您描述类或方法是什么。你必须自己写。许多IDE帮助你在类、方法等上添加空的javadoc块@Jesper:所以你同意erikkallen的答案，但你还是因为答案的形式和缺乏解释而让他失望。事实上，这对我来说是公平的。对于需要生成x公斤文档的OP来说，这可能没有什么用处，但对于阅读此线程的其他人来说，这可能会有所帮助。我们有一个专门使用自动生成文档的编码员。。。。我讨厌看到/**设置用户名*/public void setUserName。。。让评论对我低声下气，却不提供任何有用的信息，这是无用的，也是令人愤怒的。