コーディング规约

コーディング規約1．1. 0版2008年03月05日改訂履歴（社内密）- 1 -目录一、命名规范 (2)1.1 P AC KAG E 的命名 (2)1.2 C LASS 的命名 ...........................................................................................................................................2 1.3 C LASS 变量的命名 ....................................................................................................................................2 1.4 S TAT IC F INAL 变量的命名 .........................................................................................................................3 1.5 数组的命名 ...............................................................................................................................................3 1.6 方法的参数 .. (3)二、编码规范 (4)2.1 P AC KAG E /I M P ORTS (4)2.2 定义顺序 ...................................................................................................................................................4 2.3 缩进..........................................................................................................................................................5 2.4 页宽..........................................................................................................................................................5 2.5 {} 对..........................................................................................................................................................6 2.6 括号..........................................................................................................................................................6 2.7 方法的行数限制 . (6)三、注释规范 (7)（社内密）- 2 -一、命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失（根据项目的不同，客户要求的编码规范也可能不一样，但是一定要让程序有良好的可读性）。

较短的单词可通过去掉“元音”形成缩写； 较长的单词可取单词的头几发符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。

使用匈牙利表示法。

1.1 Pac ka ge 的命名Package 的名字应该都是由一个小写的英文字母或数字组成（半角英数a-z,0-9）。

例： package com.neu.util ；1.2 C lass 的命名Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。

例： public class ThisAClassName{}1.3 C lass 变量的命名变量的名字必须用一个小写的英文字母开头。

后面的单词用大写字母开头。

例： userName , thisAClassMethod开头字母要有一定的规范和意义。

例：基本类型：整数类型 byte = b, short = s, int = i, long = l（社内密） - 3 -浮点类型 double = d, float = f 字符类型 char = c 逻辑类型 Boolean = b 符合类型包括：数组： array = arr, Arraylist = lst如：cUserName 表示userName 为字符类型。

1.4 Stat ic F inal 变量的命名static Final 变量的名字应该都大写，并且指出完整含义。

/***DBConfig PATH **/Public static final String DB_CONFIG_FILE_PATH = “com.neu.etrain.dbcon ”1.5 数组的命名数组应该总是用下面的方式来命名： byte[] buffer; 而不是：byte buffer[];1.6 方法的参数使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字： SetCounter(int size){ this.size = size; }（社内密）- 4 -二、编码规范2.1 Pac ka ge /Im port spackage 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。

如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。

package .stats; import java.io.*;import java.util.Observable; import hotlava.util.Application;这里 java.io.* 是用来代替InputStream 和 OutputStream 的。

2.2 定义顺序Class 内定义顺序。

static 常量public protected package privateprivate Initializerstatic initializer instance initializerinstance 变量public protected package private（社内密） - 5 -privateconstructor finalizer method static methodpublic protected package private private instance methodpublic protected package privateprivate2.3 缩进缩进应该是每行4个空格。

不要在源文件中保存Tab 字符。

在使用不同的源代码管理工具时Tab 字符将因为用户设置的不同而扩展为不同的宽度。

如果你使用 UltrEdit 作为你的 Java 源代码编辑器的话，你可以通过如下操作来禁止保存Tab 字符, 方法是通过 UltrEdit 中先设定 Tab 使用的长度是4个空格，然后用 Format|Tabs to Spaces 菜单将 Tab 转换为空格。

2.4 页宽页宽应该设置为80字符。

源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整。

在任何情况下, 超长的语句应该在一个逗号或者一个操作符后折行。

一条语句折行后, 应该比原来的语句再缩进4个字符。

（社内密） - 6 -2.5 {} 对{} 中的语句应该单独作为一行。

例如, 下面的第1行是错误的, 第2行是正确的: if (i>0) { i ++ }; // 错误, { 和 } 在同一行 if (i>0) { i ++ };// 正确, { 单独作为一行 } 语句永远单独作为一行。

如果 } 语句应该缩进到与其相对应的 { 那一行相对齐的位置。

2.6 括号左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格。

下面的例子说明括号和空格的错误及正确使用:CallProc( AParameter ); // 错误 CallProc(AParameter); // 正确不要在语句中使用无意义的括号。

括号只应该为达到某种目的而出现在源代码中。

下面的例子说明错误和正确的用法:if ((I) = 42) { // 错误 - 括号毫无意义if (I == 42) or (J == 42) then // 正确 - 的确需要括号2.7 方法的行数限制一个方法的有效代码行数最好不要超过150行，这样可以提高代码的可读性，也能让大家养成尽量提出共通方法和代码的可再利用性的习惯。

（社内密）- 7 -三、注释规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。

（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）。

Java 的语法与 C++ 极为相似，那么，你知道 Java 的注释有几种吗？是两种？// 注释一行/* ...... */ 注释若干行不完全对，除了以上两种之外，还有第三种，文档注释： /** ...... */ 注释若干行，并写入 javadoc 文档1.注释要简单明了。

但不要写在一行。

String userName = null; //用户名 不正确//用户名String userName = null; 正确2.边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。

3.在必要的地方注释，注释量要适中。

注释的内容要清楚、明了，含义准确，防止注释二义性。

保持注释与其描述的代码相邻，即注释的就近原则。

4.全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取。