------- android培训、java培训、期待与您交流!
我们在编写程序时,总需要为程序添加一些注释,用以说明某段代码的作用,或者说明某个类型的用途、某个方法的功能,以及该方法的参数和返回值的数据类型及意义等。
程序注释的作用非常大,我们在初学java语言时,不但要努力写程序,也好多添加注释,添加注释不是浪费时间。如果不添加注释,过一段时间,开始意识到当初写的程序在结构上有很多不足,需要重构。于是打开源代码,以外可以轻松地改写原有的代码,但这时发现理解原来的代码非常困难,很难理解原有的编程思路。
为什么要添加注释?至少有如下三方面考虑
1. 永远不要过于相信自己的理解力!当你思路通畅,进入编程境界时,你可以很流畅的实现某个功能,但这种流畅可能是因为你当时正处于这种开发思路中,为了在再次阅读这段代码时,还能找回当初编写代码的思路,建议添加注释!
2. 可读性第一,效率第二!在哪些“古老”的岁月里,编程时少数人的专利,他们随心所欲地写程序,他们以追求程序执行效率为目的。但随着软件行业的发展,人们发现仅有少数技术编程满足不了日益增长的软件需求,越来越多的人加入了编程队伍,并引入了工程化的方式来管理软件开发。这个时候,软件开发变成了协调作战,团队成员的沟通变得很重要,因此,一个人写的代码,需要被整个团队的其他成员所理解;而且,随着硬件设备的飞速发展,程序的可读性取代执行效率变成了第一考虑的要素。
3. 代码即文档!很多初学者认为:文档就是word文档!实际上,程序源代码是程序文档的重要组成部分,当我们想把各种软件相关文档写规范时,不要忘了把软件里最重要的文档:源代码写规范!
java语言的注释
程序注释是源代码的重要部分,对于一份规范的程序源代码而言,注释应该占到源代码的1/3以上。几乎所有的编程语言都提供了注释的方法,一般的编程语言都提供基本的单行注释和多行注释,java语言也不例外,除此之外,java语言还提供了一种文档注释。java语言的注释有三种
· 单行注释
· 多行注释
· 文档注释