blocks|key|5796420|text|javadoc是用于编写Java源代码文档的标准工具(包含在JDK中)。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|5796421|standard+Java+API+documentation是用javadoc生成的。|5796422|entityMap|0|LINK|mutability|MUTABLE|url|http://java.sun.com/j2se/javadoc/|1|http://java.sun.com/javase/6/docs/api/^0|0|7|0|0|0|V|1|0^^$0|@$1|2|3|4|5|6|7|P|8|@]|9|@$A|Q|B|R|1|S]]|C|$]]|$1|D|3|E|5|6|7|T|8|@]|9|@$A|U|B|V|1|W]]|C|$]]|$1|F|3|-4|5|6|7|X|8|@]|9|@]|C|$]]]|G|$H|$5|I|J|K|C|$L|M]]|N|$5|I|J|K|C|$L|O]]]]

<a href="http://java.sun.com/j2se/javadoc/" rel="noreferrer">javadoc</a> is the standard tool (included with the JDK) for Java source code documentation.

The <a href="http://java.sun.com/javase/6/docs/api/" rel="noreferrer">standard Java API documentation</a> has been generated with javadoc.

blocks|key|544165|text|井,|type|unstyled|depth|inlineStyleRanges|entityRanges|data|544166|肯定有javadoc。我认为它是目前为止用来记录java项目的最常用的工具。|offset|length|544167|entityMap|0|LINK|mutability|MUTABLE|url|http://java.sun.com/j2se/javadoc/^0|0|3|7|0|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|O|8|@]|9|@$D|P|E|Q|1|R]]|A|$]]|$1|F|3|-4|5|6|7|S|8|@]|9|@]|A|$]]]|G|$H|$5|I|J|K|A|$L|M]]]]

Well, 

definitely there is <a href="http://java.sun.com/j2se/javadoc/" rel="nofollow noreferrer">javadoc</a>. I think it is by far the most used tool for documenting java projects. Also, take into account that not only documents the methods and the classes but also you can document/create tutorials with static html pages and they'll appear in the generated documentation.

blocks|key|552727|text|然而，您可能想要查看Doxygen，它将提供更强大的代码导航功能和呈现选项。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|552728|entityMap|0|LINK|mutability|MUTABLE|url|http://www.doxygen.nl/^0|A|7|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

Javadoc (as noted) is the standard tool for Java. However you may want to check out <a href="http://www.doxygen.nl/" rel="nofollow noreferrer">Doxygen</a>, which will provide more powerful code navigation features and rendering options.

blocks|key|552735|text|所有最流行的IDE(例如Eclipse、NetBeans+)都会为您生成javadoc。它会列出所有的参数，抛出的异常等。对于像getters和setters这样的明显用途的方法，它也会生成足够好的注释(getX()+"Gets“等)。您需要做的是完成类和方法的javadoc注释，这些类和方法比getter、setter或默认构造函数更复杂。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|552736|还有大量的插件(+Eclipse请参见here)，例如，您可以使用它们来生成UML图来说明您的代码结构。|offset|length|552737|entityMap|0|LINK|mutability|MUTABLE|url|http://www.eclipseplugincentral.com/^0|0|J|4|0|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|O|8|@]|9|@$D|P|E|Q|1|R]]|A|$]]|$1|F|3|-4|5|6|7|S|8|@]|9|@]|A|$]]]|G|$H|$5|I|J|K|A|$L|M]]]]

All the most popular IDEs (Eclipse, NetBeans for example) would generate the javadocs for you. It would list all the parameter, thrown exceptions etc. For obvious-purpose methods like getters and setters it will also generate good enough comments (getX() "Gets x" etc.). What you'll need to do than is to complete the javadoc comments for the classes and methods that are more sophisticated than getters, setters or default constructors.

There is also plenty of plugins (for Eclipse see <a href="http://www.eclipseplugincentral.com/" rel="nofollow noreferrer">here</a>) that you can use for example to generate UML diagrams to illustrate your code structure.

blocks|key|3683843|text|自动生成的文档很糟糕。为什么会有它？它不会增加任何价值。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3683844|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

Automatically generated documentation sucks. Why have it? it doesn't add any value.

blocks|key|552744|text|多年来(十多年来)，我一直使用TallTree的DocJet+(http://www.talltree.com/)从我的Java/C%2B%2B代码中生成技术文档，并取得了非常令人满意的结果。该工具不需要任何特殊的标签(尽管它理解javadoc标签)；它足以用简单的英语描述类/方法/字段，偶尔使用诸如'return‘(或任何其他具有相同含义的表达式)，’参数‘或“参数”等。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|552745|entityMap|0|LINK|mutability|MUTABLE|url|http://www.talltree.com/^0|W|O|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

For years (more than a decade) I am using TallTree's DocJet (<a href="http://www.talltree.com/" rel="nofollow noreferrer">http://www.talltree.com/</a>) to generate technical documentation from my Java/C++ code with very satisfactory results. The tool does not require any special tags (although it understands javadoc tags); it sufficient to describe class/method/field in plain English with occasional wording such as 'return' (or any other expression with the same meaning), "parameter" or "argument" and so on.

Is there any free decent program to do code documentation for java?It's hard enough to get the coding project done and then need to spend time writing documentation as well.If you know, please tell me.

Document java code

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

EdgeOne AI 安全实战专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

有没有免费的像样的程序来为java编写代码文档?完成编码项目，然后需要花费时间编写文档作为well.If，请告诉我，这已经够难的了。

问文档java代码
EN

回答 6

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问文档java代码EN

回答 6

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问文档java代码
EN