JAVA的编程风格和规范

对于编程风格，没有绝对的标准，在程序中统一并始终如一就行。

良好的编程习惯是编写良好的程序的先决条件，规范的代码增加了代码的易读性，让人看得舒服，看着赏心悦目。

下面列出一些我个人比较认同的编程规范。

一、命名约定

1、类名、接口名和枚举类型名采用骆驼命名法，每个单词首字母大写，例如CountingNumber

2、变量名、方法名首单词小写，其余单词只有首字母大写，例如firstName

3、常量和静态常量全部用大写字母，单词间用下划线分隔，例如MAX_NUM

 

二、注释

1、文档注释 ：  /**........*/

文档注释被javadoc处理，可以建立类的一个外部说明文档。文档注释必须写在类、域、构造函数、方法、和字段定义之前，对这些定义的含义、功能等进行说明。

/**

*。。。。

*/

2、C风格注释  /* ......*/

可以注释掉一行或者多行不再使用的代码段，但是这些代码仍有保留的价值。

3、单行注释  //

格式上一般注释符//后紧跟一个空格，然后才是注释信息。

对于程序注释，不宜多也不宜少，不必要对每一行代码都注释，只需要在关键的地方、或者有逻辑、有难度的地方加以注释，方便别人读懂程序。

 

三、代码排版

1、缩进

一般缩进为4个宽度为宜，不同的编辑工具可能有不同的设置，但是一般都默认4个宽度。2个太窄，8个太宽，都不合适，不美观。

2、{ }对

“{”应紧跟在他所属的语句后面，并且语句应该相对“{“所在的行缩进2个宽度。”}“单独一行，并且与前面语句的第一个字符对齐。

例如：

while(i > 0)  {

    i++;

}

注：C++中{ }经常采用上下对齐的风格，例如VS默认的就是”{“和”}“都占一行并上下对齐。在java中也可以采用这种风格，但是sun公司出来的java风格标准采用上面的那种，与C++区别开来，所以宜采用java公认的标准风格。

3、（）括号

左括号与第一个字符之间不应该有空格，右括号不应该与最后一个字符之间有空格。

4、空行

适当使用空行将不同功能或者不同逻辑块划分，使程序美观、易读。