一、目的
▲统一公司软件开发设计过程的编程规范。
▲使网站开发人员能很方便地理解每个目录，变量，控件，类，方法的意义。
▲保证编写出的程序都符合相同的规范，保证一致性，统一性。
▲编码规范和约定必须能明显改善代码的可读性，并有助于代码管理，分类范围适用于企业所有基于java平台的软件开发工作。
二、规范细节
1、代码规范
（1）命名规则
▲一个唯一包名的的前缀总是全部小写的ASCII字母。
▲类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。
▲接口的大小写规则与类名相似。
▲方法名是一个动词，采用大小写混合的方法，第一个单词的首字母小写，其后单词的首字母大写。
▲变量名中可以包含字母、下划线（—）、数字、美元符号（$）、人民币符号（￥），不能以数字开头，变量名应简短且富于描述，应该易于记忆，避免单个字符的变量名，除非是一次性的临时变量，第一个单词的首字母小写。
▲常量的声明应该全部大写。
（2）注释规范
▲所有的源文件都应该在开头有一个注释，其中列出文件名，日期和类的功能概述。
▲每个方法必须添加文档注释[累的main()方法除外]。
▲代码或者实现细节需要15%的注释量。
▲注释使用中文。
（3）缩进排版规范
▲避免一行的长度超过60个字符。
▲使用MyEclipse的源代码的格式化功能完成代码的缩进排版。
（4）文件名规范
▲一个java源文件只能存储一个公有型（public修饰）的java类。
▲文件名与公有型的java类名相同。
▲一个类文件的代码行不超过200行。
（5）声明规范
▲一行声明一个变量。
▲不要将不同类型变量的声明放在同一行。
▲只在代码块的开始处声明变量。
▲方法与方法之间以空行分隔。
（6）语句规范
▲每行至多包含一条简单语句。
▲if语句代码块总是用“{”和“}”括起来。
▲当在for语句的初始化或更新字句中使用逗号时，避免因使用三个以上的变量而导致复杂度提高。
▲每行switch的一个case自上向下执行时（因为没有break语句），通常应在break语句的位置添加注释。
（7）编程规范
（1）原则
▲提供可视反馈。在后台运行长进程时（时间超过10秒，视具体情况而定），必须提供进度条件等信息知识。
▲保证页面能很快对用户操作做出反应。
▲提供快捷键。
▲界面应该很简单（不是过分单纯化），易于学习，并且易于使用。
▲界面美观，能够吸引用户。
▲对用一控件的规范要求应一致。
（2）命令行程序运行界面规范
▲背景为白色，前景为黑色。
▲字体为宋体，24号。
（3）安全性规范
当三次输入错误的验证信息后，应该禁用该用户的账户或暂时禁用。
（4）界面风格规范
▲用户界面控件看起来应该是一致的。
▲将重要信息放在上面和左边。
▲使用左对齐来使用户界面控件更易于浏览。
▲不同界面中的同一功能应该使用同样的图标和图片。图标，图片的色调与风格尽量保持一致。
▲截屏使用JPEG格式，1024x768x32位色彩。
▲使用统一的CSS。
（5）界面控制规范
▲总给列表框提供一个标签，必须用标签标明列表框的用途。
▲使列表框至少5行长，少于5行的列表没有滑块，不便于滚动。
▲将静态文本标签置于相关控件的左边，而不是上面。
▲左对齐静态文本标签，左对齐使得标签外观更有条理，且易于浏览。
▲避免不好的背景，将文本放在实的，颜色适中的背景上，确保在文本和背景之间存在良好的对比。
▲采用日期和时间拾取空间进行日期输入。
（6）字体规范
字体统一使用以下设置：字符集GBK，宋体。
（7）界面展示规范
▲数据按照列表显示时，每页数据不超过10行。
▲数据按照列表显示时，首先为选择空间，其次为数据信息，最后为操作按钮。
（8）界面操作规范
▲对输入控件，如果没有输入，应给出提示的消息框。
▲对输入控件，应给出相应的必填的提示标签。
三、规范代码样例
/**
* 第一个java程序
*/
package s1java;
public class HelloBdqn{
private int classVar1; //类参数1
private Object classVar2; //类参数2
private int instanceVar; //实列参数2
private final int CONSTNUM = 5; //常量数
public static void main(String[] args){
//输入对象的描述
System.out.println(new HElloBdqn());
}
/**
* 返回类实列的描述字符串
* @return 类实列的描述字符串
*/
public String toString(){
//返回一个描述用的字符串
return "Hello BDQN!";
}
/**
* 返回当前实例的classVar1属性值
* @return classVar1属性值
*/
public int getClassVar1(){
return classVar1;
}
/**
* 设置当前实例化的classVar1属性值
* @param classVar1要设置的classVar1属性值 */
public void setClassVar1(int classVar1){
this.classVar1 = classVar1;
}
}