| 网站首页 | 业界新闻 | 小组 | 威客 | 人才 | 下载频道 | 博客 | 代码贴 | 在线编程 | 编程论坛
欢迎加入我们,一同切磋技术
用户名:   
 
密 码:  
共有 1583 人关注过本帖
标题:建议以后对核心代码进行注释
只看楼主 加入收藏
gupiao175
Rank: 16Rank: 16Rank: 16Rank: 16
等 级:版主
威 望:40
帖 子:1787
专家分:7527
注 册:2007-6-27
结帖率:100%
收藏
已结贴  问题点数:100 回复次数:30 
建议以后对核心代码进行注释
   建议高手以后能对核心代码进行注释!
   其实并不需要每字每句都加备注或注释,比如基本定义,基本输入输出,在百度上能直接找到的就不一定要做详细注释了,关键核心点注释一下即可!做个核心注释,浪费不了您多少时间,而且好处多多,何乐而不为呢?常见好处如下:
   一、方便自己(自己写的代码多了,难免会有些代码的核心意义连自己都忘记的,我相信没有谁的记忆力能过目永不忘,很多代码也是你从别人那学习过来的,短期内也许你能记得,项目做多做广了以后,你还能记得吗?所以做个简单备注/注释,方便将来自己查阅,就如同高手都有自己的知识数据库,其实就是一种变相的注释!)。
   二、方便新人(基本用法他可以自己查,核心你已经给他做了注释了,努力去看就能更快看懂)。
   三、方便将来接替和维护你代码的人!(这个不用说了,很多教材上就已经强调过了!实际工作中更能体会到他的好处,尤其是在你接替某个人的代码进行维护的时候,如果他的代码多而杂,而且还没注释,此时可能想死的心都有,看一个不属于自己风格的又没有注释的代码是多么的耗时!所以将心比心,如果你也写一大丢你自己风格的代码,但是却从不写注释,那么接替你的人会怎么恨死你,一般的老板都会要求写注释或文档,不管代码复杂度,目的是让你养成习惯,不写的他可能让你直接滚蛋!)
   三条里可能方便自己很多人理解不来。总认为写注释好的是别人,写注释与我何干?我凭什么花时间给别人写注释呢?对自己毫无意义,所以他们拒绝把时间花在写注释上!这点在工作中和学习中都能深深感受到!所以不管是为自己还是为别人,或者适应工作,都建议你写写注释吧,哪怕只是几个基本核心的注解!简单的几个说明文字!加几个核心注释有什么不好呢?
  顶者皆有分,大家请放心,本人没有任何其他号!绝对不会做自己散分自己号去接的事!
  分数到时候视帖子数量多少平均分配!不按人头,只按帖子算,也就是说我不会去检查是否同一个人重复顶贴,一个人可重复顶贴,顶2次算2次的分。顶多次算多次!
  6月11日周六结贴!走过路过,千万不要错过!到100分为终止!如果因为后期顶帖超过这个100分制无法给分的,这里先说声对不住了。

[ 本帖最后由 gupiao175 于 2011-6-9 21:33 编辑 ]
收到的鲜花
  • voidx2011-06-08 22:40 送鲜花  5朵   附言:赞同 + 自省
搜索更多相关主题的帖子: 记忆力 
2011-06-08 22:37
gupiao175
Rank: 16Rank: 16Rank: 16Rank: 16
等 级:版主
威 望:40
帖 子:1787
专家分:7527
注 册:2007-6-27
收藏
得分:0 
    呵呵,自己沙发!
    发这个帖子的原因是前些日子,看到有人直接拿谷歌和百度上找的资料发出来。然后冠以自己的名字,以显示自己的算法或技术有多厉害。其代码结果连一句注释都没有。这种代码是高手写的吗?当然不是说不要百度上找资料,如果你找了资料还能负责任的认真测试一下并做附加些基本的注解!这个东西多少也算是你自己的!如果能把别人看不懂的东西分析完整,那就更没得说了!哪怕你的资料是百度上找来的。反之如果只是把干枯枯的代码甩出来。其他什么也没有。你让看的人做何感受呢?
     我个人认为:高手写的一定有注释。有注释的不一定是高手!这是我一直以来的看法。如果连一句核心注释都没有,哪怕他技术牛,也是牛给他自己的,而且这种人一般没有群体意识,所以称不上所未的高手!


[ 本帖最后由 gupiao175 于 2011-6-8 23:00 编辑 ]

Q:1428196631,百度:开发地 即可找到我,有事请留言!
2011-06-08 22:41
cosdos
Rank: 9Rank: 9Rank: 9
来 自:ShangHai
等 级:蜘蛛侠
威 望:6
帖 子:2109
专家分:1385
注 册:2007-6-19
收藏
得分:5 
支持支持

—>〉Sun〈<—
2011-06-08 22:45
laoyang103
Rank: 19Rank: 19Rank: 19Rank: 19Rank: 19Rank: 19
来 自:内蒙古包头
等 级:贵宾
威 望:19
帖 子:3082
专家分:11056
注 册:2010-5-22
收藏
得分:5 
楼主太大方了  接分要紧  接完分在写注释

                                         
===========深入<----------------->浅出============
2011-06-08 22:48
kelas
Rank: 6Rank: 6
等 级:侠之大者
帖 子:176
专家分:434
注 册:2010-5-28
收藏
得分:5 
支持ing!!!
2011-06-08 22:50
voidx
Rank: 12Rank: 12Rank: 12
来 自:邯郸
等 级:火箭侠
帖 子:1250
专家分:3538
注 册:2011-4-7
收藏
得分:5 
啊对,光评分了,忘了接分了,哇咔咔,勇敢接~~
2011-06-08 22:51
kelas
Rank: 6Rank: 6
等 级:侠之大者
帖 子:176
专家分:434
注 册:2010-5-28
收藏
得分:0 
现在开始工作了
阅读别人的代码、怎一个累字了得
2011-06-08 22:51
烟雾中的迷茫
Rank: 9Rank: 9Rank: 9
等 级:蜘蛛侠
帖 子:621
专家分:1069
注 册:2011-2-9
收藏
得分:5 
嗯 支持啊
2011-06-08 22:59
gupiao175
Rank: 16Rank: 16Rank: 16Rank: 16
等 级:版主
威 望:40
帖 子:1787
专家分:7527
注 册:2007-6-27
收藏
得分:0 
以下是引用laoyang103在2011-6-8 22:48:23的发言:

楼主太大方了  接分要紧  接完分在写注释

还好吧,希望更多的人能看见。写代码注释的人更多一些而已!

Q:1428196631,百度:开发地 即可找到我,有事请留言!
2011-06-08 23:19
waterstar
Rank: 11Rank: 11Rank: 11Rank: 11
等 级:小飞侠
威 望:5
帖 子:984
专家分:2810
注 册:2010-2-12
收藏
得分:5 
楼主威武,接分

冰冻三尺,非一日之寒;士别三日,不足刮目相看!
2011-06-08 23:25
快速回复:建议以后对核心代码进行注释
数据加载中...
 
   



关于我们 | 广告合作 | 编程中国 | 清除Cookies | TOP | 手机版

编程中国 版权所有,并保留所有权利。
Powered by Discuz, Processed in 0.023585 second(s), 8 queries.
Copyright©2004-2024, BCCN.NET, All Rights Reserved