首页 > 代码库 > Java代码注释
Java代码注释
通过代码注释,可提高程序的可读性。注释中包含了程序的信息,可以帮助从程序员更好的阅读和理解程序。Java源文件的任意位置都可以添加注释语句。注释的文字Java编译器不进行编译,所有代码中的注释文字对程序不产生影响。Java提供了三种注释方法,分别为单行注释,多行注释,文档注释。
1 单行注释
“//”为单行注释的符号,从符号“//”开始到换行位置均为注释而被Java编译器忽略。语法如下:
//注释内容
例如:以下代码为声明int型变量添加注释。
int age; //定义int型变量用于保存年龄信息
2 多行注释
“/**/”为多行注释标记,符号“/*”与“*/”之间的所有内容都为注释内容。注释中的内容可以】换行。
语法如下:
/*
注释内容1
注释内容2
*/
注意
多行注释中可以嵌套单行,例如:
/*
程序名称:hello Word //开发时间为2017年
*/
但是在多行注释中不能嵌套多行注释,例如:
/*
程序名称:hello Word
/*
开发时间:2017年
作者:CHEN
*/
*/
此程序为错误的。
3 文档注释
“/***/”为文档注释的符号,符号“/**”与符号“*/”之间额内容为注释内容。当文档注释出现在声明变量(如类的声、明类成员变量的声明、类成员方法的声明等)之前时,会被Javadoc文档工读取为Javadoc文档内容。文档注释的格式与多行注释的格式相同,对于初学者而言,文档注释并不是很重要,了解即可。
说明
一定要养成良好的编程风格,软件编程规范中提到“可读性第一,,效率第二”,所以程序员一定要在编程中添加适量的注释来提高代码的可读性和可维护性。程序中注释要占程序代码总量的20%~50%。
Java代码注释