A股上市公司传智教育(股票代码 003032)旗下技术交流社区北京昌平校区

 找回密码
 加入黑马

QQ登录

只需一步,快速开始

© 何小红 中级黑马   /  2012-9-29 19:45  /  2424 人查看  /  1 人回复  /   0 人收藏 转载请遵从CC协议 禁止商业使用本文

添加注释的重要性
我们在编写程序时,总需要为程序添加一些注释,用以说明某段代码的作用,或者说明某个类的用途,某个方法的功能,以及该方法的参数和返回值的数据类型和意义等。
程序注释的作用非常大,很多学生在开始学习JAVA语言时,会很努力写程序,但不大会注意添加注释(我也一样哈),看一些文档,才知道注释的重要性,总结一下,有如下三个方面,(但是不是复制喔,是我一个字一个字的敲的喔,大家看看吧)
1,永远不要过于相信自己的理解力!当你思路通畅时,进入编程境界(编程也是一种境界,需要静下心来~)你可以很流畅的实现某个功能,但这种流畅可能是因为你当时正处于这种开发思路中,为了能在再次阅读这段代码时,还能找回当初编写这段代码的思路,建议添加注释!
2,可读性第一,效率第二!在那些“古老”的岁月里,编程是少数人的专利,他们随心所欲地写程序,他们以追逐程序执行效率为目的。但随着软件行业的发展,人们发现仅有少数技术Hacker编程满足不了日益增长的软件需求,越来越多的人加入了编程队伍,并引入了工程你给的方式来管理软件开发。这个时候,软件开发成为一种团队协同作战,团队成员的沟通变得很重要,因此,一个人写的代码,需要被整个团队的其他人所理解,而且,随着硬件设备飞速发那展,程序的执行效率不再是第一考虑的要素,程序的可读必变成了第一考虑的要素。
3,代码即文档!程序源代码是程序文档的重要组成部分,当我们想着把各种软件相关文档写规范的时候,不要忘了把软件里最重要的文档,源代码写规范!

程序注释是源代码的一个重要部分,对于一份规范的程序源代码而言,注释应该占到源代码的1/3以上。

所以各位同学,一定要注意养成习惯,在源代码里多添加注释,对以后的工作是很有帮助的!

评分

参与人数 1黑马币 +30 收起 理由
王海宇 + 30

查看全部评分

1 个回复

倒序浏览
注释的重要性不言而喻,但是那种函数里面都是注释的风格太坑爹了,《重构》里面一条重要的原则,如果你发现你的函数里面需要写注释了,可以试试extract method,分成很多小的函数,从函数名称就可以知道这个函数的作用~~JDK里面也是这个风格,基本很少在JDK源码的函数里面找到注释,因为都抽取出方法了
回复 使用道具 举报
您需要登录后才可以回帖 登录 | 加入黑马