软件编码规范剖析.doc

软件编码规范 编 制： 莫 小 明 版 本 历 史 目录 1 概述 3 1.1. 内容 3 1.2. 编写目的 3 1.3. 阅读对象 3 2 java编码命名规范 4 2.1 Package 的命名 4 2.2 Class 的命名 4 2.3 变量及方法命名 4 2.4 Static Final 变量的命名 4 2.5 参数的命名 5 2.6 数组的定义及命名 5 2.7 方法的参数 5 2.8 内部循环变量的命名 5 2.9 JavaBean规范 5 3 java注释规范 6 3.1 单行注释 6 3.2 类注释 6 3.3 方法注释 7 3.4 变量注释 8 4 java编码排版规范 8 4.1 =间的空格 8 4.2 空行 8 4.3 换行 9 4.4 缩进 9 4.5 声明 9 4.6 括号 10 5 java编码格式约定 10 6 数据库编码命名规范 12 6.1 大小写说明 12 6.2 数据库表命名 12 6.3 视图命名 12 6.4 自定义函数命名 12 6.5 PL/SQL 存储过程命名 12 6.6 JAVA存储过程命名 12 6.7 数据库包命名 13 6.8 自定义类型命名 13 6.9 字段名命名 13 6.10 字段别名 13 7 数据库SQL语句格式 13 7.1 大小写说明 13 7.2 INSERT INTO 语句 14 7.3 UPDATE 语句 14 7.4 SELECT 语句 14 8 补充说明异常抛出 15 8.1 Service层异常的抛出 15 8.2 控制层异常的处理 16 9 方法修饰说明 16 10 调用过程说明 17 概述 内容 本规范说明书从大方面来说包括：java编码规范、数据库表、字段等的命名、SQL语句排版，以及后面补充的一些说明。 编写目的 编码规范对于程序员而言尤为重要，有以下几个原因：一个软件的生命周期中，80%的花费在于维护几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码增加可读性，减少项目组中因为换人而带来的损失如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品 java编码命名Package 的命名 Package 的名字应该都是由一个小写单词组成。 package com.soa.service.bi.fi; package com.soa.service.sox4; Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。public abstract class AbstractSox4Service { /*内容*/ } 变量及方法命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头 EG 变量：userName ,方法名： getUserInformation、addNews Static Final 变量的命名 static Final 变量的名字应该都大写，并且指出完整含义。 //DBConfig PATH public static final String DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig; 参数的命名 参数的名字必须和变量的命名规范一致。 数组的命名 数组应该总是用下面的方式来命名： byte[] buffer; 而不是： byte buffer[];方法的参数 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字： setCounter(int size) { this.size = size; } 内部循环变量的命名 请不要用i、j、n等没有意义的变量命名； 不要怕麻烦，请使用带有意义的单词命名； 如：userListSize、rowLength等来命。 JavaBean规范 一个javaBean类必须是一个公共类，类都得设置为public 一个javaBean类必须有一个空的构造函数必须有一个不带有参数的公用构造器。此构造器也应该通过调用各个特性的设置方法来设置特性的缺省值 一个javaBean类不应有公共实例变量，类变量都为private持有值应该通过一组存取方法（getXxx和setXxx）来访问对于需要的每个特性，应该有一个带有匹配公用getter 和setter 方法的专用实例变量。注释规范注释要简单明了。//用户名Str