软件开发规范.doc

软件开发规范


java命名规范
1)package命名:package 的名字应该都是由一组小写单词组成。
2) Class 命名: Clas的缩写。(如果没有约定的缩写，则采用该单词前4个字母来表示)。
3) 数据表字段命名规则:
)数据库字段名全部采用小写英文单词，单词之间用”_”隔开。字段长度不能超过30个字符。
)如果该字段是代码，则在单词后加_id。
)如果该字段表示的是时间，则使用_time为后缀。
4) 视图命名规则:
)视图名用V_开头，视图名长度不能超过30个字符。视图名用大写的英文单词来表示。
)视图由几个表产生就用下划线(_)连接几个表的名，如果表过多可以将表名适当简化，但一定要列出所有表名。
5) 序列命名规则:序列名用seq_开头，后面跟使用该序列的字段名。如果有几个字段用同一个序列，用下划线(_)连接几个字段的名称。如果不同表中相同的字段名需要使用不 同的序列，则在字段名后加表的特征，用下划线(_)连接。序列名长度不能超过30个字符。序列名用小写的英文单词来表示。
6) 存储过程命名规则:存储过程名用Pr_开头，存储过程名长度不能超过30个字符。存储过程名用小写的英文单词来表示。
7) 函数命名规则:函数名用Fu_开头，函数名长度不能超过30个字符。函数名用小写的英文单词来表示。
8) 触发器命名规则:触发器名用Tr_开头，触发器名长度不能超过30个字符。触发器名用小写的英文单词来表示。
9) 主键命名规则:主键名用pk_开头，后面跟该主键所在的表名。主键名长度不能超过30个字符。如果过长，可对表名进行缩写。缩写规则同表名的缩写规则。主键名用小写的英文单词来表示。
10) 外键命名规则:外键名用fk_开头，后面跟该外键所在的表名和对应的主表名(不含t_)。子表名和父表名自己用下划线(_)分隔。外键名长度不能超过30个字符。如果过长，可对表名进行缩写。缩写规则同表名的缩写规则。外键名用小写的英文单词来表示。
11) 索引命名规则:
)索引名用小写的英文字母和数字表示。索引名的长度不能超过30个字符。
)主键对应的索引和主键同名。
)唯一性索引用uni_开头，后面跟表名。一般性索引用ind_开头，后面跟表名。
)如果索引长度过长，可对表名进行缩写。缩写规则同表名的缩写规则。
12) sql 语句规范: 所有 sql 关键词全部大写，比如 SELECT 、 UPDATE 、 FROM 、 ORDER BY 等

文件注释
文件开始注释正例:
/**
* @描述:
* @包名:${package_name}
* @类名:${type_name}
* @日期:${date}
* @版权:Copyright ?诚迈科技. All right reserved.
* @作者:${user}
*/
类和接口注释
1) 类、接口的注释采用 /** … */，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。