◆ 符号命名规则
符号名包括：模块名，变量名，常量名，方法（函数/子程序）名,数据区名,缓冲区名等。符号命名通常应遵循以下规则：
通用规则：
1、在所有命名中，都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写，除非该名字描述的是中文特有的内容，如半角、全角, 声母、韵母等。
2、所有命名都应遵循达意原则，即名称应含义清晰、明确。
3、所有命名都不易过长，应控制在规定的最大长度以内。
4、所有命名都应尽量使用全称。
5、如果命名使用缩写，则必须对其进行注释和说明。
具体规范：
1、工程名  统一制订。
2、文件名
    文件名应与类名相同，这是java的规范
3、方法名/函数名
✧ ·方法名第一个单词小写。
✧ ·推荐使用动宾结构。方法名应清晰反映该方法的功能、用途。
✧ ·方法名最长不得超过30个字符。
  例：
    getCollection();
    setCollection();
    insertObject();
    deleteObject();
3、变量名
必须使用有意义的变量名。
推荐的类型缩写（type）——
·char：ch
·boolean：b
·int：i
·long：l
·double：d
·float：f 
变量名最长不得超过20个字符。
4、类名
✧ ·必须以大写字母开头，类名反映具体含义，以清晰表达类的用途和功能为原则
✧ ·当名称由多个单词构成时，每一个单词的第一个字母必须大写
◆ 代码书写规范
书写规范即在编写代码过程中所使用的标准格式， 主要包括空格的使用、括号的使用、缩近格式和其他一些内容。
源代码书写规范
1．在.java/.jsp的开头应有一段格式统一的说明，内容包括：
    a. 文件名 (Title/FileName)；
    b. 创建人 (Author)；
    c. 文件创建时间 (Date)；
    d. 简短说明文件功能、用途 (Description /Function)。
样例：
/**
* 标题:            Schedule.java
* 描述:            用来实现计划项目审批
* 创建:            2001-06-30
* 作者:            赵文正
* 详细：        详细描述计划项目审批的细节,如何根据细节功能确定方法
*/
2. 除非极其简单，否则对函数应有注释说明。内容包括：功能、入口/出口参数，必要时还可有备注或补充说明。
3. 每行代码的长度推荐为80列，最长不得超过120列；折行以对齐为准。
4. 在类的成员函数内调用其他类的成员函数时，其他类的成员函数可做简短说明。
6. 函数入口参数有缺省值时，应注释说明。
例:
float getValue(int  ID,  boolean  flag) {
/* parameter description
    ID: Identify No
    flag : default = TRUE
*/
…
}
7. else if 必须写在一行。
8. 与‘{’、‘}’有关的各项规定：
1 　‘{’、‘}’应独占一行。在该行内可有注释。
  例：正确：
  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]);
    }
2 ‘{’必须另起一行，‘{’之后的代码必须缩进一个Tab。‘{’ 与 ‘}’必须在同一列上。
例：正确：
      if (i > 0)
      {
          m = 1;
          n++;
      }
    不得写做：
    if (i > 0) {
      m = 1;
      n++;
      }
3 在循环、分支之后若只有一行代码，虽然可省略‘{’、‘}’，但不推荐这么做。若省略后可能    引起歧义，则必须加上‘{’、‘}’。
例：正确：
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. 与空格有关的各项规定。
1 所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在 ‘.’、‘[’、‘]’等运算符前后，及‘&’（取地址）等运算符之后不得有空格。
例：正确：
int n = 0, nTemp;
for (int i = nMinLine; i <= nMaxLine; i++)
不得写做：
int n=0, nTemp;
for ( int i=nMinLine; i<=nMaxLine; i++ )
2 or、while、if 等关键词之后应有1个空格，再接‘(’，之后无空格；在结尾的‘)’前不得有空格。
例：正确：
if (-2 == n)
不得写做：
if(-2 == n)
或
java和jspif ( -2 == n )
等等。
3 调用函数时，‘(’、‘)’前后不得有空格。
4 类型强制转换时，‘(’‘)’前后不得有空格
10. 与缩进有关的各项规定
①　缩进以 Tab 为单位。1 个 Tab 为 4 个空格
②　下列情况，代码缩进一个 Tab:
函数体相对函数名及‘{’、‘}’。
if、else、for、while、do 等之后的代码。
一行之内写不下，折行之后的代码，应在合理的位置进行折行。若有 + - * / 等运算符，则
运算符应在上一行末尾，而不应在下一行的行首。
③    下列情况，不必缩进：switch 之后的 case、default。
在switch-case结构中，case语句距离switch 语句的开始应缩进一个TAB，每个case的程序体距离case的开始缩进一个TAB;
举例：
        switch (value)
        {
                case 1:
                        /* Body for case 1. */
                        break;
                case 2:
                        /* Body for case 2. */
                        break;
                default:
                        /* Body for default. */
                        break;
        }
④　所有的函数定义和函数定义的花括号都应位于第一列；
⑤　所有成对的花括号都应出现在同一列，并与相应的控制语句同列，在对数组、类、和枚举类型的成员初始化时，同样遵循此规则； 
⑥　对于java/jsp程序，强烈建议使用如下结构：
    try{
        ……
    }
    catch(Exception ex){
        ……
    }
    finally {
        try {
          ……
        }
        catch (Exception e) {
          ……
        }
    }
⑦　其他
对复杂的条件语句（分支中的语句较多），应在每个结束的花括号后加一条注释说明是哪一个分支的结束，并在分支的开始加注释说明进入分支的条件；复杂的循环程序段遵循此规则；
每个语句占一行；

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。