Java代码注释和编码规范

Java 代码注释和编码规范

1. 代码注释

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

​ 1.2 多行注释 “/* "和”*/"为多行注释标记，符号之间所有内容均为注释内容，注释内容可换行。

​ 1.3 文档注释 “/** */"为文档注释标记，符号之间的所有内容均为文档注释内容。

注意：在多行注释中可嵌套单行注释，但在多行注释中不可嵌套多行注释。

2. 编码规范

​ 2.1 每条语句要单独占一行，一条命令一分号结束。

​ 2.2 声明变量时尽量使每个变量的声明单独占一行，即使相同也单行放置。

​ 2.3 在java代码中关键字与关键字之间若有多个空格，均被视为一个。

​ 2.4 尽量使用简单的技术完成程序需要的功能。

​ 2.5 对于关键的方法要多加注释。