没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论




























格式:docx 资源大小:9.4MB 页数:64


项目全称
编码规范
承建方全称
2013 年 4 月

目录
项目全称 .........................................................................1
编码规范 .........................................................................1
1 命名规范 .......................................................................1
1.1 常量命名.................................................................1
1.2 变量命名.................................................................1
1.2.1 域/类变量..........................................................1
1.2.2 局部变量...........................................................2
1.2.3 静态变量...........................................................2
1.3 方法参数命名.............................................................2
1.4 方法命名.................................................................3
1.5 类命名...................................................................4
1.6 包命名...................................................................5
1.7 配置 Bean 命名............................................................6
1.8 文件命名.................................................................6
1.9 数据表命名...............................................................7
1.10 数据项命名..............................................................7
1.11 外键命名................................................................9
1.12 索引命名................................................................9
2 注释规范 .......................................................................9
3 编码规范 ......................................................................10
3.1 开发环境................................................................10
3.2 编码风格................................................................11
3.3 接口规范................................................................11
3.4 目录规范................................................................12
3.4.1 源文件目录........................................................12
3.4.2 Web 资源文件目录 ..................................................14
3.5 UI 前台编写规范 .........................................................15
3.6 JAVA 编写规范 ...........................................................18
3.7 JAVA 集合类规范 .........................................................19
3.8 Ajax 应用规范 ...........................................................19
3.9 JSP 编写规范 ............................................................19
3.10 JS 编写规范 ............................................................20
3.10.1 文件名命名规范...................................................20
3.10.2 命名空间(NameSpace)格式........................................21
3.10.3 命名规范.........................................................22
3.10.4 书写规范.........................................................23
3.10.5 对象创建说明.....................................................23
3.10.6 全局变量.........................................................24
3.11 SQL 编写规范 ...........................................................25
3.12 编码最佳实践...........................................................26
4 异常规范 ......................................................................26

5 日志规范 ......................................................................26
5.1 系统日志................................................................26
5.2 业务日志................................................................27
6 Maven 依赖构建规范 ............................................................28
6.1 Maven 依赖 ..............................................................28
7 流程规范 ......................................................................28
7.1 流程说明................................................................28
7.2 相关工具................................................................28
7.3 文档规范................................................................29
8 版本管理规范 ..................................................................29
8.1 文档规范................................................................29
8.2 代码规范................................................................30

1 命名规范
总原则:
➢ 名称中不能以‘_’ 、‘$’等特殊字符开头和结尾;
➢ 命名尽可能遵循术语表,尽可能符合标准的英文单词或缩写,缩写在术语表
中需有说明;
➢ 命名尽可能做到见名知意,含义清晰准确,同时注意避免产生二义性;
1.1 常量命名
➢ 常量统一大写;
➢ 程序中的固定数字、字符串等,必须用常量来表示,并能正确表达其含义;
➢ 常量尽可能写在相应的常量类中;
【例子】
STATUS_OF_START,STATUS_OF_END 开始状态,结束状态
PATTERN_OF_URL_FILTER
1.2 变量命名
➢ 自定义类型变量命名尽可能尽量保持和类名相同,只是首字母小写;
【例子】 UserRole userRole;
➢ 当针对接口命名变量时,去掉变量前缀 I,其他规则不变;
【例子】 IUserService userService;
➢ 除了循环内部,竟可能避免使用单个字符做变量;
【例子】 For(int i=0; i<length; i++){…};
1.2.1 域/类变量
➢ 以小写字母开头,单词之间以大写母分割;

➢ 标识复数时尽可能以's'结尾,当's'无法表述时则以相应的集合类型做结尾;
➢ 如果出现同类型的多变量声明,则应加业务单词前缀限定,避免直接在变量
后加数字的方式区分;
【例子】
List users
Map personMap
GradeExam gradeExam , GradeExam refGradeExam
1.2.2 局部变量
➢ 以小写字母开头,单词之间以大写母分割;
➢ 标识集合时应以相应的类型做些结尾,或者特殊类型的变量,通常使用其类
型作为后缀,过长的特殊类型允许使用缩写;
【例子】
User[] userArray
List userList
Map userMap ;
➢ 对于相同类型的多变量声明,加业务含义前缀限定
【例子】User user; User checkedUser;
1.2.3 静态变量
➢ 静态变量统一大写;
➢ 如果是一组静态变量,名称的开头应有类型限定词,词之间用下划线分割;
【例子】
ACTION_OF_ADD, ACTION_OF_UPDATE
1.3 方法参数命名
➢ 以小写字母开头,单词之间以大写母分割
➢ 其他规则同局部变量
剩余32页未读,继续阅读
资源评论


nazala1681
- 粉丝: 1
上传资源 快速赚钱
我的内容管理 展开
我的资源 快来上传第一个资源
我的收益
登录查看自己的收益我的积分 登录查看自己的积分
我的C币 登录后查看C币余额
我的收藏
我的下载
下载帮助


最新资源
- 使用Matlab_GNU Octave绘制GNUCAP_NGSPICE sim数据_Plot GNUCAP_NGSPIC
- Arduino和Matlab-使用ADIOES-GUI读写_Arduino and Matlab- Read and w
- Model using ns-3 simulator on Linux to simulate IEEE 802.11
- Endurance PCTx电缆的Matlab接口_Matlab interface for the Endurance
- Se crea una comunicación con dispositivo de sensado 3D (MPU)
- Matlab和C中的简单调频在德州仪器的C上实现_A simple fm modulation in Matlab an
- VMware虚拟机安装与配置实战教程:从零搭建完整虚拟化环境
- 一个用C编写的训练高斯混合模型的库,带有MATLAB和Python的包装器。_A library for trainin
- 第 3 讲:KAFKA生产者(Producer)详解
- HC-SR04超声波测距模块完整教程:从原理到Arduino实战应用源码
- 【计算机视觉】基于PaddleX的C#模型部署:Windows10环境下C++预测库与TensorRT集成应用
- 信用卡管理信息表-Excel 可视化模板工具:让数据说话更简单!
- 同花顺(同花顺远航版)
- CCS教程:从零开始掌握CCS开发环境与嵌入式系统实战源码
- 共享单车数据-共享单车数据系统-共享单车数据系统源码-共享单车数据系统代码-springboot共享单车数据系统源码-基于springboot的共享单车数据系统设计与实现-共享单车数据管理系统代码
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈



安全验证
文档复制为VIP权益,开通VIP直接复制
