代码注释与编码规范

在代码种适当的加入注释可以提高代码的可读性。好的编码规范可以使程序更容易阅读和理解，代码写出时我们能够看懂但是间隔一段时间过后再去看代码就需要一些时间了，但有了注释我们就又可以轻易的读懂了。

代码注释：

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

              例如：int age;                   //定义int型变量用于保存年龄信息

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

             例如：/*

                          内容1

                         内容2

                          .......

                       */

          注意：多行注释中可以嵌套单行注释，也可以嵌套多行注释。

        文档注释：“/** */”为文档注释标记。符号“/**”与“*/”之间的内容均为文档注释内容。当文档注释出现在声明（如类的成员变量的声明、类的成员方法的声明等）之前时，会被java doc文档工具读取作为java doc文档内容。

编码规范：

      在学习开发的过程中要养成良好的编码习惯，以下对编码规范的总结：

           1、每条语句要单独占一行，一条命令要以分号结尾。

           2、在声明变量时，尽量使每个变量的声明单独占一行，即使是相同的数据类型也要将其放置在单独一行上，这样有助于添加注释。对于局部变量应声明的同时对其进行初始化。

           3、在java代码中。关键字减如果右多个空格，这些空格均被视为一个。多个空格没有任何意义，为了便于理解阅读，控制好空格的数量。

           4、对于关键的方法要多加注释，这样有助于阅读者了解代码结构。