为什么写java代码的注释这么纠结!!!

hanvslin 2010-09-08 05:27:26
为什么写java代码的注释这么纠结!!!是我语文水平太差?英语水平太差??
不是不想写注释,可是发现要写好的注释真不容易!
...全文
342 32 打赏 收藏 转发到动态 举报
写回复
用AI写文章
32 条回复
切换为时间正序
请发表友善的回复…
发表回复
shijing125 2010-09-10
  • 打赏
  • 举报
回复
如果你觉得注释不好写的话 说明你的代码需要重构 你可以读读敏捷开发的文章 ~~对你应该有帮助
soton_dolphin 2010-09-10
  • 打赏
  • 举报
回复
写注释是程序员最基本的习惯
fhqlpgk1218 2010-09-10
  • 打赏
  • 举报
回复
我觉得java的注释还不错啊~!!~
michaellufhl 2010-09-09
  • 打赏
  • 举报
回复

可以参考JDK源码的注释。

还可以利用Eclipse里面javadoc view的功能很方便的查看自己写的javadoc。
qianqian0424 2010-09-09
  • 打赏
  • 举报
回复
寫注釋很重要啊,不能忽略
shehun 2010-09-09
  • 打赏
  • 举报
回复
按自己的思路写一下就可以了,如果方法做的事情太多可以分解
凉岑玉 2010-09-09
  • 打赏
  • 举报
回复
写得让自己过后来看都还看得懂每个地方的代码的意思和意义··
youjianbo_han_87 2010-09-09
  • 打赏
  • 举报
回复
如果是用IDE的话,比如Eclipse,可以在 windows - perferences - java - Code Style 里面定制注释啊。。。。
麦田捕手 2010-09-09
  • 打赏
  • 举报
回复
写注释是良好的编程习惯,我一开始也不愿意写,但后来新做的工程中经常会用到以往的代码,以前的代码有注释的话,那读起来就非常迅速、容易
猿敲月下码 2010-09-09
  • 打赏
  • 举报
回复
恩,对于一个方法要做的事情只有一样.不要把N个功能都放在同一个方法里头去

这样的话注释起来简单明了,直接说明该方法是干什么用的,参数情况,返回值情况
dahaidao 2010-09-09
  • 打赏
  • 举报
回复
算了吧,这么难,还写它干什么。
  • 打赏
  • 举报
回复
写注释很难么,就把你写的东西思路和用处写一下就可以了啊。
lzw0286 2010-09-09
  • 打赏
  • 举报
回复
[Quote=引用 27 楼 hanvslin 的回复:]
引用 26 楼 zhwkingsun 的回复:

做到3行代码2行注释,就不会困解这个问题了,在简单的代码都这样做,这样对你对他人都有好处,有过这样的经验,就是自己写的代码过一段时间后在去看有的时候自己看都要看好一会,如果有了注释我觉得无论是你自己看还是他人看,很短时间内就能看懂了
注释太多了也不好吧,给人感觉不连贯......感觉一个方法写个注释够了!
[/Quote]

代码的注释过多,会导致一个问题,就是以后维护的人不愿意同步修改注释,因为代码的注释太多了,不易修改,最后的结果就是注释跟代码完全脱节,给阅读代码的人带来问题。。。
注释这个东西,适度吧。。。 方法短小精干,写注释好写,同时更容易复用。。
hanvslin 2010-09-09
  • 打赏
  • 举报
回复
[Quote=引用 26 楼 zhwkingsun 的回复:]

做到3行代码2行注释,就不会困解这个问题了,在简单的代码都这样做,这样对你对他人都有好处,有过这样的经验,就是自己写的代码过一段时间后在去看有的时候自己看都要看好一会,如果有了注释我觉得无论是你自己看还是他人看,很短时间内就能看懂了
[/Quote]注释太多了也不好吧,给人感觉不连贯......感觉一个方法写个注释够了!
zhwkingsun 2010-09-09
  • 打赏
  • 举报
回复
做到3行代码2行注释,就不会困解这个问题了,在简单的代码都这样做,这样对你对他人都有好处,有过这样的经验,就是自己写的代码过一段时间后在去看有的时候自己看都要看好一会,如果有了注释我觉得无论是你自己看还是他人看,很短时间内就能看懂了
zy_110 2010-09-09
  • 打赏
  • 举报
回复
一定要养成写注释的好习惯

这也是做到代码规范的一步
榴莲酥2013 2010-09-09
  • 打赏
  • 举报
回复
养成好的注释习惯,对别人对自己都好.别人可以很容易读懂代码.
xiaoshuang1990 2010-09-09
  • 打赏
  • 举报
回复
[Quote=引用 17 楼 michaellufhl 的回复:]
可以参考JDK源码的注释。

还可以利用Eclipse里面javadoc view的功能很方便的查看自己写的javadoc。
[/Quote]
这样行。。
zuoguodang 2010-09-09
  • 打赏
  • 举报
回复
没有注释是不行的
24K純帥 2010-09-09
  • 打赏
  • 举报
回复
注释是必须的~
加载更多回复(11)

62,614

社区成员

发帖
与我相关
我的任务
社区描述
Java 2 Standard Edition
社区管理员
  • Java SE
加入社区
  • 近7日
  • 近30日
  • 至今
社区公告
暂无公告

试试用AI创作助手写篇文章吧