Java入门代码注释与编码规范（羊驼）

一、代码注释

1.单行注释

“//”为单行注释标记，从符号“//”开始直到换行位置的所有内容均做为注释而被编辑器忽略

//注释内容

2.多行注释

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

/*
注释内容
*/

/*注释内容*/

提示：

在多行注释中可以加嵌套单行注释例：
 

/*

        程序名称：Hellow world //开发时间：2008-03-05

*/

但在多行注释中不可以嵌套多行注释，以下代码为非法：

    /*
        程序名称：Hello World
/*开发时间：2008-03-05
  作者：羊驼
*/
    */

3.文档注释

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

二、编码规范

在学习开发的过程要养成良好的编码习惯，因为规范的代码格式会给程序的开发与日后的维护提供很大的方便。在此编码规则作了以下总结

1.每条语句要单独占一行，一条命令要以分号结束

2.在声明变量时，尽量使每个变量的声明单独占一行，即使是相同的数据类型也要将其放置在单独一行上，这样有助于添加注释

3.在java代码中，关键字与关键字之间如果有多个空格，这些空格均视为一个

4.为了方便日后的维护，不要使用技术性很高、难懂、易混乱的判断语句，由于程序的开发与维护不能是同一个人，所以应尽量使用简单技术完成程序需要的功能

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