Java 基础知识02——代码注释与编码规范

#代码注释与编码规范

1. 代码注释
2. 编码规范
   

代码注释

通过在程序代码中添加注释可提高程序的可读性。注释中包含了程序的信息，可以帮助程序员更好的阅读和理解程序。在Java源程序文件的任意位置都可以添加注释语句。有三种注释方法，分别为单行注释、多行注释和文档注释。

---

一、代码注释

1. 单行注释
   “//”为单行注释，从“//”到换行结束都是注释

int age;	//声明int 变量来存储年龄信息；

2. 多行注释
   “/* */”为多行注释标记，注释中内容可以换行。
   注意：在多行注释中可以嵌套单行注释，但是嵌套多行注释

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

3. 文档注释
   “/** */” 为文档注释，文档注释与多行注释格式相同。对于初学者来说，了解即可。

说明：一定要养成良好的编程风格。软件编码规范中提到“可读性第一，效率第二”，所以在程序中加适量的注释来提高程序的可读性和可维护性。

二、编码规范

  在学习开发的过程中养成良好的编码习惯是非常有必要的，因为规整的代码格式可以给程序开发和以后的维护提供很大的方便。

1. 每条语句要单独占一行，一条命令要以分号结束。
   注意：程序代码中的分号是在英文的状态下输入的，若是在中文状态在输入，则会报“Invalid Character”错
2. 在声明变量时，尽量使每一个变量的声明单独占一行，即使是相同的数据类型也要将其放置在单独的一行上，这样有助于添加注释。对于局部变量应在声明的同时对其进行初始化。
3. 在Java代码中，关键字之间如果有多个空格，这些空格均被视为一个。