Java代码书写规范(高手必经之路).docVIP

符号命名规 通则：1、在所有命名中，都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写，除非该名字描述的是中文特有的内容，如半角、全角, 声母、韵母等。 2、所有命名都应遵循达意原则，即名称应含义清晰、明确。 3、所有命名都不易过长，应控制在规定的最大长度以内。 4、所有命名都应尽量使用全称。 5、如果命名使用缩写，则必须对其进行注释和说明。 具体规范： 工程名统一。 文件名函数名·方法名第一个写。·推荐使用动宾结构。名应清晰反映的功能、用途。·方法名最长不得超过30个字符。 3、变量名类型缩写（type）·char：ch ·boolean：b ·int：·long：l·double：d·float：f 变量名最长不得超过20个字符。 类名·必须以大写开头，反映具体含义，以清晰表达类的用途和功能为原则·当名称由多个单词构成时，每一个单词的第一个字母必须大写书写规范 书写规范即在编写代码过程中所使用的标准格式， 主要包括的使用、的使用、和一些内容。源代码书写规范在./.jsp的开头应有一段格式统一的说明，内容包括： a. 文件名 (FileName)； b. 创建人 ()； c. 文件创建时间 (Date)； d. 简短说明文件功能、用途 (Description)。 /** * 标题: Schedule.java * 描述: 用来实现计划项目审批 * 创建: 2001-06-30 * 作者: 赵文正 * 详细： 详细描述计划项目审批的细节,如何根据细节功能确定方法 */ 2. 除非极其简单，否则对函数应有注释说明。内容包括：功能、入口/出口参数，必要时还可有备注或补充说明。 3. 每行代码的长度推荐为80列，最长不得超过120列；折行以对齐为准。 . 在类的成员函数内调用。 . 函数入口参数有缺省值时，应注释说明。 例: (int ID, boolean flag) { /* parameter description ID: Identify No flag : default = TRUE */ … } 7. else if 必须写在一行。 . 与‘{’、‘}’有关的各项规定： ‘{’、‘}’应独占一行。在该行内可有注释。 例：正确： for (i = 0; i Line; i++) { // System.out.println(Line=+ i+” value = ”+Lines[i]); } 不得写做： for (i = 0; i cb; i++) { System.out.println(Line=+ i+” value = ”+Lines[i]); } ‘{’必须另起一行，‘{’之后的代码必须缩进一个Tab。‘{’ 与 ‘}’必须在同一列上。 例：正确： if (i 0) { m = 1; n++; } 不得写做： if (i 0) { m = 1; n++; } 在循环、分支之后若只有一行代码，虽然可省略‘{’、‘}’，但不推荐这么做。若省略后可能引起歧义，则必须加上‘{’、‘}’。例：正确： if (n == -2) { n = 1; } else if (n != nTemp) { n = 2; } else { n = 3; } 不得写做： if (n == -2) n = 1; else if (n != nTemp) n = 2; else n = 3; 9. 与空格有关的各项规定。 所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在 ‘.’、‘[’、‘]’等运算符前后，及‘’（取地址）等运算符之后不得有空格。例：正确： int n = 0, nTemp; for (int i = nMinLine; i = nMaxLine; i++) 不得写做： int n=0, nTemp; for ( int i=nMinLine; i=nMaxLine; i++ ) or、while、if 等关键词之后应有1个空格，再接‘(’，之后无空格；在结尾的‘)’前不得有空格。例：正确： if (-2 == n) 不得写做： if(-2 == n) 或 if ( -2 == n )等等。 调用函数时，‘(’、‘)’前后不得有空格。类型强制转换时，‘(’‘)’前后不得有空格 与缩进有关的各项规定缩进以 Tab 为单位。1 个 Tab 为 4 个空格 下列情况，代码缩进一个 Tab:函数体相对函数名及‘{’、‘}’