代码如何注释?
上一节
下一节
一、Java程序的注释
程序的注释是为了方便程序的阅读,给程序添加的一些说明性文字。Java语言提供了3种添加注释的方法:
1、单行注释:以“//”为标记,从符号“//”后的字符开始到该行结束的内容,用在说明性文字比较少,能够在1行内写完的场合。
2、多行注释:以“/* */”为标记、在符号“/*”和 “*/”之间的所有内容,通常用在说明性文字比较多,需要写多行的场合,但也可以是1行。
3、文档注释:以“/** */”为标记、在符号“*/”和 “*/”之间的所有内容,使用方法与多行注释相同。它的诱人之处是在声明语句前面的文档注释会被Javadoc文档工具读取生成Javadoc文档,注释对的内容一般包含描述性文本及若干个Javadoc标签,Javadoc标签一般以@为前缀,常用的Javadoc标签如@author、@version等。
二、Java编码规范
编码规范是指在程序开发中程序员应该遵守的一些编码规则。 Java的基本编码规则总结如下:
1、每条语句要单独占一行,一条命令要以分号结束;
2、声明变量时尽量要分行声明;
3、不要使用技术性很高、难懂、易混淆判断的语句;
4、对于关键的方法要多加注释。