锁定老帖子 主题:实践中的重构23_详尽的注释未必是好注释
精华帖 (0) :: 良好帖 (0) :: 新手帖 (0) :: 隐藏帖 (0)
|
|
---|---|
作者 | 正文 |
发表时间:2011-03-22
aws 写道 好的程序员写出的代码,直接看代码,看命名和逻辑和接口就会很清晰明了,不需要太多注释
没经验的程序员往往写出一堆逻辑乱七八糟,命名稀奇古怪,胡乱跳转的东西,这种加了再多注释也是枉然 同意这个观点,但是一定的注释还是有必要的 |
|
返回顶楼 | |
发表时间:2011-03-22
这不是注释的问题,注释越简明越好,注释拖拉不是注释的问题,而是方法操作比较复杂!
|
|
返回顶楼 | |
发表时间:2011-03-22
最后修改:2011-03-22
见过最蛋疼的注释就是:
1.在构造方法上加注释: /** * 无参构造方法 */ /** * 有参构造方法 */ 2. 在setter getter上加注释: /** * xxx的set方法 */ /** * xxx的get方法 */ |
|
返回顶楼 | |
发表时间:2011-03-22
其实注释是写给别人看,也是写给自己看。
|
|
返回顶楼 | |
发表时间:2011-03-22
关于注释我看了许多,我发现一个奇怪的问题,许多人写注释喜欢写what,但是不喜欢写why,很简单的一个列子,给一个变量赋值
a = 0,我看到过很多人的注释是“ //令a的值变为0” 但是对于我们程序员而言,很多时候这种注释对我们没什么帮助,我们更希望知道为什么要使a=0,对此修改会造成何种影响等等,至于a=0这句描述的是什么意思,我相信任何一个智商正常的人都看的明白的,也就是说这句注释是个累赘,拙见 哈哈 |
|
返回顶楼 | |
发表时间:2011-03-22
少写注释,多写自解释的代码。
|
|
返回顶楼 | |
发表时间:2011-03-22
我的观点从来都是代码自注释,比如方法名,参数名,一个方法他自己应该告诉别人我是做什么的,而不是写上一段注释告诉别人我是做什么的。而且如果注释没有维护好,反而会误导别人,本来一开始你想放方法A做A,但是后来你把方法A改成去做其他了,注释没有相应的维护好,那么后面人就被你忽悠了。
|
|
返回顶楼 | |
发表时间:2011-03-22
月落码农 写道 我的观点从来都是代码自注释,比如方法名,参数名,一个方法他自己应该告诉别人我是做什么的,而不是写上一段注释告诉别人我是做什么的。而且如果注释没有维护好,反而会误导别人,本来一开始你想放方法A做A,但是后来你把方法A改成去做其他了,注释没有相应的维护好,那么后面人就被你忽悠了。
对于简单的代码可以这么做,不过复杂的操作还是必须介绍一下! |
|
返回顶楼 | |
发表时间:2011-03-22
Bruce.Sun 写道 关于注释我看了许多,我发现一个奇怪的问题,许多人写注释喜欢写what,但是不喜欢写why,很简单的一个列子,给一个变量赋值
a = 0,我看到过很多人的注释是“ //令a的值变为0” 但是对于我们程序员而言,很多时候这种注释对我们没什么帮助,我们更希望知道为什么要使a=0,对此修改会造成何种影响等等,至于a=0这句描述的是什么意思,我相信任何一个智商正常的人都看的明白的,也就是说这句注释是个累赘,拙见 哈哈 +1 多写为什么的注释代码 |
|
返回顶楼 | |
发表时间:2011-03-23
这是代码和文档的同步问题,well design 的代码远比详尽的注释好
|
|
返回顶楼 | |