Java 代码注释

Java 代码注释

1 单行注释

“//”为单行注释标记，从符号“//”开始直到换行为止的所有内容均作为注释而被编译器忽略。

//注释内容

例如：

int a = 10 ;      //a的数据类型为整型

2．多行注释

“/* */”为多行注释标记，符号“/”与“/”之间的所有内容均为注释内容。

/*
注释内容1
注释内容2
…
*/

例如：

/*
这个项目的大概流程：
1.
2.
*/

3．文档注释

“/** */”为文档注释标记。符号“/**”与“*/”之间的内容均为文档注释内容。

/**
 * 1.我们先对问题进行分析
 * 2.对此查找相关的数据
 * 3.根据问题建立模型
 * 4.对模型编写合适的算法
 * 5.求出问题的结果
 */

我们在编写代码时，一定要养成良好的编程习惯。软件编码规范中提到“可读性第一，效率第二”，所以程序员必须在程序中添加适量的注释来提高程序的可读性和可维护性。程序中，注释要占程序代码总量的20%～50%。