JAVA/JSP编程规范参考

      1、 命名规范

     （1）Package的命名： package的名字应该都是由一个小写单词组成。

    （2）Class的命名： Class的名字必须由大些字母开头而其他字母都由小写的单词组成

    （3）Class变量的命名： Class变量的名字必须用一个小写字母开头，后面的单词用大写字母开头。

    （4）Static Final 变量的命名：Static Final 变量的名字应该都大写，并且指出完整含义

    （5）参数的命名： 参数的名字必须和变量的命名规范一致

     （6）数组的命名： 数组应该总是用byte[] buffer而不是byte buffer[]

     （7）方法的参数： 使用有意义的参数命名， 如果可能的话，使用和要赋值的字段一样的名字：SetCounter(int size){this.size=size}

 

   2、 Java文件样式

   (1)版权信息： 必须在Java文件的开头如：

     /**

     *Copyright @2009 changsha xxx Co.Ltd

    *All right reserved

  */

  (2)Package/Imports: Package行要在import行之前， import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录则应该用*来处理

  (3)Class ： 注释同版权信息类似， 关于定义： 包含了不同行的extends和implements：

    public class CounterSet

    extends Observable

   implements Cloneable

 

   (4)存取方法，如果只是简单的set/get方法的话则可以简单地写成一行

   (5)构造函数:  构造函数应该用递增的方式写， 例如参数多的写在后面

    (6)main方法， 应该写在类的底部

 

  3、  代码编写格式

    (1)代码样式化： 代码应该用UNIX的格式，而不是Windows

    (2)文档化： 必须用javadoc来为类生成文档

   (3)缩进：  缩进应该是每行两个空格， 不要在源文件中保存Tab字符

   (4)页宽： 页宽应该设置为80字符， 对于超长的语句应该在一个逗号或一个操作符后折行， 一条语句折行后，应该比原来的语句在缩进两个字符。 另外建议： 语句应该永远单独作为一行

  (5)括号： 左括号和后一个字字符之间不应出现空格， 同样右括号和前一个字符之间也不应该有空格。