注释概述
首先注释是解释编程中变量,方法,类含义的一种语法,不被jvm解析。
java中注释分三种,分别是单行注释 //,多行注释及/* */ 文档注释/** */。单行注释可以嵌套,多行注释不可以被嵌套。eclipse有单行多行注释快捷键,单行注释用ctrl+shift+c或者ctrl+c,多行注释用shift+ctrl+/。(eclipse最重要的快捷键ctrl+shift+L,调出大部分快捷键)。文档注释是java特有的注释,其中的注释内容可以被jdk所提供javadoc工具(和java,javac一样的可执行文件)所解析。生成一套网页文件形式的该程序说明文档。
为什么写注释?
注释就是你所写方法,变量,类等的解释,方便让别人看懂你写代码的逻辑思路。就好比中国人(程序员A)和法国人(程序员B)需要进行交流,他们一般都是用英文来进行交流(程序员交流代码用注释),相当于注释可以把你的想法思路告诉别人。一个好的程序注释都差不多能达到1/3,有些时候注释量甚至超过了代码量。一般许多语言都通用的东西都是需要我们好好掌握的,比如算法,数据结构,注释啊。你说哪种编程语言不需要注释。
注释的好处?
1:提高程序阅读性; 2:可以在写代码之前写出代码思路(用注释) 3:程序员看说明性文档可以快速知道这个成员变量,方法等功能,作用(文档注释)。 4:代码测试的时候也可以把怀疑出错的地方注释掉,即可以纠错。