blocks|key|5076399|text|在任何一篇文章中，你都是为你的听众写的。您的听众是维护开发人员，您可能是在3年后忘记了所有工作的细节之后的您。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|5076400|单次使用丢弃代码，可能可以注释得更少。需要对其他开发人员使用的API进行更多记录。|5076401|在任何情况下，都不需要只重复方法签名的javadoc+(例如，“这是一个返回值为void和名称为HelloWorld的方法，不带参数调用”)|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|G|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|H|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|I|8|@]|9|@]|A|$]]]|F|$]]

In any writing, you write for your audience. Your audience is the maintenance developer, which may be you after 3 years after you have forgotten the details of how it all works.

Single use throw away code, probably can be commented less. APIs to be consumed by other developers needs to be documented more.

In no case does anyone need javadoc that only repeats the method signature (e.g. "This is a method with a return value of void and a name of HelloWorld and is invoked with no paramters")

blocks|key|5076328|text|这通常是团队/公司的决定，没有正确或错误的答案。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|5076329|它也适用于正在开发的软件类型；外部公开和消费相对于内部公开和消费。|5076330|有任何评论；使它们有用。不要反悔方法签名。|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|G|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|H|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|I|8|@]|9|@]|A|$]]]|F|$]]

This is generally a team/company decision; there is no right or wrong answer. 

It is also applicable to the type of software being developed; externally exposed and consumed versus internally exposed and consumed.

With any comments; make them useful. Do not regurgitate the method signature.

blocks|key|1337964|text|不向我的代码提供javadoc是错误的吗？|type|blockquote|depth|inlineStyleRanges|entityRanges|data|1337965|是。不创建有意义的javadoc是错误的。|unstyled|1337966|编写毫无意义、信息贫乏的模板javadoc是错误的。|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|H|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|I|8|@]|9|@]|A|$]]|$1|E|3|F|5|D|7|J|8|@]|9|@]|A|$]]]|G|$]]

<blockquote>
 Is it wrong to not supply javadoc with my code?
</blockquote>

Yes. It's wrong not to create meaningful javadoc.

It is wrong to write meaningless, uninformative boilerplate javadoc.

blocks|key|1338012|text|Javadoc几乎是记录java代码的公认标准。能够将其转换为HTML只是其中一个好处；更重要的是，所有主要的Java也都理解它，它们将在编写代码时使用它来显示上下文敏感的帮助。如果您不坚持javadoc语法，这是行不通的，而且对于习惯使用这种方便特性的人来说，使用您的代码非常恼人(尤其是在Java世界中，用IDE而不是简单的文本编辑器编写代码是常态)。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1338013|总之，使用自己的评论风格是自私、固执和幼稚的。学习javadoc。这并不难，甚至对你未来的职业生涯也有好处。|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|E|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|F|8|@]|9|@]|A|$]]]|D|$]]

Javadoc is pretty much the accepted standard for documenting java code. Being able to convert it into HTML is just one of the benefits; a much more important one is that all the major Java IDEs understand it as well, and they will use it to display context-sensitive help while you code. If you don't adhere to javadoc syntax, this doesn't work and makes working with your code very annoying for people who are used to this convenience feature (and especially in the Java world, coding in an IDE rather than a simple text editor is the norm).

In short, using your own commenting style is selfish, stubborn and childish. Learn javadoc. It's not that hard, and it might even be beneficial for your future career.

blocks|key|5076377|text|我要说的是，不确定您开发的代码是否清楚、可以理解地记录了当前的情况，这是错误的。这意味着是情境性的。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|5076378|作为一名实习生，要考虑到你编写的所有代码都是别人的责任。这增加了什么是可以理解的文档的赌注。|5076379|尤其是javadoc，这取决于您和您的雇主，但您应该确保某些东西会留给其他人使用。|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|G|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|H|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|I|8|@]|9|@]|A|$]]]|F|$]]

I would say it's wrong not to make certain that the code you develop is clearly and understandably documented for the situation at hand. What that means is situational.

As an intern, consider that all the code you write is going to be someone else's responsibility. That ups the ante for what constitutes understandable documentation.

As far as javadoc in particular, that is up to you and your employer, but you should definitely be sure that something gets left behind for another person to use.

blocks|key|1338061|text|如果问题是很难坚持javadoc语法，那么一个好的IDE就会有帮助。例如，在Eclipse中，使用/**类型a@打开注释，代码完成功能将列出可用的注释。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1338062|检查结果就像将鼠标指针悬停在方法名称上一样简单。这也使得在不切换到web浏览器查看文档存储库的情况下，查找文档变得非常快速和容易。|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|E|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|F|8|@]|9|@]|A|$]]]|D|$]]

If the problem is you find it hard to adhere to the javadoc syntax, a good IDE will help. For example, in Eclipse, open a comment with /** type an @ and the code completion feature will list the annotations available.

Checking the result is as simple as hovering the mouse pointer over the method name. This also makes looking up the documentation really quick and easy without swapping to a web browser to view a documentation repository.

blocks|key|5076462|text|JavaDoc使您的代码更易于使用。当涉及到错误修复或修改代码时，我怀疑它比普通注释有更好的帮助，但是在其他项目中使用您的类要容易得多，因此当JavaDoc注释允许其他程序员查找和使用您的类和方法时，使用类更容易。由于代码重用通常比重新发明轮子更好，所以省略JavaDoc是很难接受的，除非您的代码非常糟糕，所以无论如何重用都不是一种选择。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|entityMap^0^^$0|@$1|2|3|4|5|6|7|C|8|@]|9|@]|A|$]]]|B|$]]

JavaDoc makes your code easier to use. I doubt it helps better than normal comments when it comes to bugfixing or modifying the code, but using your classes in other projects is by far easier and therefore more likely when JavaDoc comments allow other programmers to find and use your classes and methods. Since code reuse is generally better than reinventing the wheel, the omission of JavaDoc is hardly acceptable unless your code is so bad that reuse is not an option anyway.

I do a lot of Java programming at my work (I'm an intern) and I was wondering if it is generally a rule to create javadoc to accompany my code. I usually document every method and class anyways, but I find it hard to adhere to Javadoc's syntax (writing down the variables and the output so that the parser can generate html).

I've looked at a lot of C programming and even C++ and I like the way they are commented. Is it wrong not to supply javadoc with my code?

Is it wrong not to create Javadoc for my code?

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

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

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

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

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

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

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

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云AI代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

功能1上新10个字符

功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符。

功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符。

功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符

功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符

功能4上新

文章&问答评论现已支持表情

全新交互，全新视觉，新增快捷键、悬浮工具栏、高亮块等功能并同时优化现有功能，全面提升创作效率和体验

社区富文本编辑器全新改版！诚邀体验～ 

精选全网热门MCP server，让你的AI更好用 🚀

💥开发者 MCP广场重磅上线！

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

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

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

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

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

社区新版编辑器体验调研

我在我的工作中做了很多Java编程(我是一名实习生)，我想知道，创建javadoc来陪伴我的代码是否通常是一条规则。我通常记录每个方法和类，但我发现很难坚持Javadoc的语法(写下变量和输出，以便解析器生成html)。我看过很多C编程，甚至C++和我喜欢它们的注释方式。不向我的代码提供javadoc是错误的吗？

问不为我的代码创建Javadoc是错误的吗？
EN

回答 7

Software Engineering用户

Software Engineering用户

Software Engineering用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问不为我的代码创建Javadoc是错误的吗？EN

回答 7

Software Engineering用户

Software Engineering用户

Software Engineering用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问不为我的代码创建Javadoc是错误的吗？
EN