社区
Java SE
帖子详情
为什么写java代码的注释这么纠结!!!
hanvslin
2010-09-08 05:27:26
为什么写java代码的注释这么纠结!!!是我语文水平太差?英语水平太差??
不是不想写注释,可是发现要写好的注释真不容易!
...全文
342
32
打赏
收藏
为什么写java代码的注释这么纠结!!!
为什么写java代码的注释这么纠结!!!是我语文水平太差?英语水平太差?? 不是不想写注释,可是发现要写好的注释真不容易!
复制链接
扫一扫
分享
转发到动态
举报
写回复
配置赞助广告
用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
打赏
举报
回复
算了吧,这么难,还写它干什么。
开门大吉送吉祥
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)
安卓手机查看
java
源码-DavidAndroidProjectTools:Android开发常用功能大集合。以及知识点的详解
代码
安卓手机查看
java
源码 DavidAndroidProjectTools Android开发常用功能大集合。以及知识点的详解
代码
项目名称:【Android利器】 前提说明,仅供参考.若是用于商业本人不负任何法律责任.有些接口是我自己抓取的,版权归原公司所有. 此项目是小冰工作中总结常用的功能大集合,防止以后用到的话重复造轮子,而且还有常用控件 以及难点的详解,
注释
非常啰嗦,纯粹是为了积累自己的知识,顺便方便自己查看。当然,说到各种 小功能,肯定少不了各种工具类与自定义View等等,我会和做项目一样,分包,并且要求和我自己做项目差不多 不过,每个人的习惯都不相同,具体分包不要
纠结
。希望大家能和我一样能看懂
代码
,学会理解,一起提高自我技能。 由于我也要上班,所以功能会慢慢地长期更新,维护此
代码
,所以,有bug或者好建议,欢迎提出。 当然,如果你有更好的功能,欢迎联系我。好知识一起共享。Thank You!下面是部分的功能知识点介绍: 包名图(当然,这个项目功能点挺多的,具体请下载apk或者运行项目自己看。喜欢的朋友可以点star) 【Android方面】里面主要是四大模块: 1,主
jvm_book:《深入理解
Java
虚拟机(第3版)》样例
代码
&勘误
《深入理解
Java
虚拟机(第3版)》 广告: 《》: 这是一部以“讨论如何构筑一套可靠的分布式大型软件系统”为主题的免费开源文档,如对您有用,望不吝给个Star 不是广告: 快速环境构建、编译、裁剪、调试: JetBrains的远程方案,不用
纠结
如何搭建IDE环境调试HotSpot源码了,如对您有用,望不吝给个Star 本工程为《深入理解
Java
虚拟机(第3版)》书中的样例
代码
,以方便读者自行测试。部分
代码
需要在特定的虚拟机版本、参数下运行,在
代码
前均已“VM Args”的
注释
进行标注。 书中的勘误也会在本文中持续更新,读者可通过issues提交新的勘误,如对新版有任何建议,也欢迎以或任何其他您方便的形式提出。 勘误列表: 目录XIV,Page164 4.3.3 VisualVM:多合 - 故障处理工具中”的【多合 - 】应该是【多合一】 这个在原稿上是多合一,但印刷后确实怎么看都
Java
编码易疏忽的十个问题
在
Java
编码中,我们容易犯一些错误,也容易疏忽一些问题,因此笔者对日常编码中曾遇到的一些经典情形归纳整理成文,以共同探讨。 1、
纠结
的同名 现象 很多类的命名相同(例如:常见于异常、常量、日志等类),导致在import时,有时候张冠李戴,这种错误有时候很隐蔽。因为往往同名的类功能也类似,所以IDE不会提示warn。 解决
写
完
代码
时,扫视下import部分,看看有没有不熟悉的。替换成正确导入后,要注意下
注释
是否也作相应修改。 启示 命名尽量避开重复名,特别要避开与JDK中的类重名,否则容易导入错,同时存在大量重名类,在查找时,也需要更多
JAVA
代码
注释
规范
注:此文为转载文章,原文地址点这里!!! 一直
纠结
注释
规范问题,看了一些文档不仅头疼反而更迷糊了,偶然看到下面这篇文章,简单明了豁然开朗,手痒转了过来,文章如下。
JAVA
代码
注释
规范
代码
注释
是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序
代码
可维护性的重要环节之一。所以我们不是为
写
注释
而
写
注释
。下面说一下在开发中使用的
代码
注释
规范,供大家参考下。
Java
程序中Doc(文档)
注释
详解
许多人
写
代码
时总不喜欢
写
注释
,每个程序员如此,嘿嘿,我也一样 不过,话说回来,该
写
还是要
写
哦!没人会喜欢一个不
写
注释
的程序员,当然,也没有一个喜欢
写
注释
的程序员,今天,我们就来说说
Java
注释
之一——Doc
注释
我们知道,
Java
支持 3 种
注释
,分别是单行
注释
、多行
注释
和文档
注释
,我们来看看他们的样子 //单行
注释
/* 多行
注释
*/ /** *@... *.... *文档
注释
*/ 可能许多萌新不明白,
写
了这些
注释
有什么用呢? 其实是因为初学者的
代码
量少,没有
注释
也能快速查找、修改.
Java SE
62,614
社区成员
307,327
社区内容
发帖
与我相关
我的任务
Java SE
Java 2 Standard Edition
复制链接
扫一扫
分享
社区描述
Java 2 Standard Edition
社区管理员
加入社区
获取链接或二维码
近7日
近30日
至今
加载中
查看更多榜单
社区公告
暂无公告
试试用AI创作助手写篇文章吧
+ 用AI写文章