代码开发规范V01.docx
- 文档编号:16999388
- 上传时间:2023-07-21
- 格式:DOCX
- 页数:6
- 大小:21.27KB
代码开发规范V01.docx
《代码开发规范V01.docx》由会员分享,可在线阅读,更多相关《代码开发规范V01.docx(6页珍藏版)》请在冰点文库上搜索。
代码开发规范V01
开发规范
版本历史
版本/状态
作者
参与者
起止日期
备注
V0.1
张磊
2013-04-28
1概述
1.1编写目的
本文档作为EOMS门户系统(E_PORTAL)代码设计的重要依据,阐述在开发的过程中需要遵守的约束。
主要描述在开发过程中有关包,类,接口,方法,实例变量,变量和常量的命名规则。
1.2读者对象
读者角色
角色描述
IT支撑人员
负责运维福建门户二期人员
设计人员
负责本业务功能的设计人员
开发人员
IT落地的研发人员
测试人员
系统功能、性能的测试人员
1.3适用范围
适用于开发和维护门户产品的相关人员
1.4术语与缩写解释
列出本报告中用到的专门术语的定义。
缩写、术语
解释
…
2命名规范
2.1包命名规范
包的概念在开发的过程中会经常出现,它的规则要遵守:
1、包名全部都是小写字母
2、包名中不能出现下划线
3、第一个字母不能是数字
4、以公司域名反向开始(com.boco.eoms.portal),按照模块从大到小的顺序
2.2类名、接口命名规范
类和接口本质上都是一个类,他们的名称应该是一个名词,它的命名一般有两部分组成业务含义和逻辑含义(ExcelImportMgr),可以采用大小写混合的方式,每个单词的首字母应该是大写的,接口的名称应以Impl开始。
例如:
1、控制层(Portlet),则业务+portlet,如:
DutyManagerPortlet
2、如果是业务层(service)接口类以Mgr结尾,实现类以Impl结尾
3、如果是数据库层(Dao)接口类以Dao结尾,实现类以DaoHibernate
2.3方法命名规范
方法名应是一个动词或动词结构,采用大小写混合的方式,其中第一个单词的首字母小写,其后的单词的首字母大写。
●添加动作:
以add开始的方法,如addXxx;
●保存动作:
以save开始的方法,如saveXxx;
●获得一个单个对象:
以get开始的方法,如getXxx;
●获得数据集合:
以list开始的方法,如listXxx;
●编辑的动作:
以edit开始的方法,如editXxx;
●数据更新动作:
以update开始的方,如updateXxx;
●数据删除动作:
以remove开始的方法,如removeXxx;
2.4常量命名规范
常量名应全部采用大写,单词间可以采用下划线隔开。
例如:
StringVIEW_JSP=“”;
IntMAX_VALUE=“”;
2.5变量命名规范
变量名也一般采用大小写混合的方式,第一个单词的首字母小写,其后的单词的首字母大写,变量名一般不要采用下划线开头。
变量名应简短且有意义,即要指出实际的用途。
例如:
StringuserId=“”;//表示用户id
StringportletName=“”//portlet的名称
2.6前台文件的命名
前台的文件包括jsp,js,css等,它们的命名要符合它们的业务含义;
例如:
TabNoTitle.jsp//没有标题的tab页面
Json.js//json方面的js
Form.css//框架类的css
3代码抒写规范
类的方法的代码行数不能过长,尽量控制在100行以内,长的方法需要拆分成私有方法。
3.1返回值
方法的返回值不应是null,尽量用异常代替放回null。
3.2异常
我们使用java提供的异常类,让他检测抛出特定的错误,以便研发人员能够快速的定位错误。
3.3表达式
我们应该熟悉常用的算术和逻辑表达式,因为这个可以简化我们的代码,提高代码质量。
3.4注释
注释是软件代码可读性的具体体现,质量高的代码注释应该占比较高的比列。
常用的有三类注释,具体如下:
1、类说明注释:
它一般位于import之前,要求写出内容说明,创建者,创建(修改)时间,注意事项等。
2、方法名注释:
每个方法都要进行适当的说明,包括方法说明,参数说明,异常说明,返回值说明和特殊说明等。
3、行注释:
用于特殊的代码行说明,紧用作调试使用,在程序调试完成后要将其删除,以免影响程序的可读性。
4页面jsp开发规范
5数据库设计
5.1表的设计
1、表的命名一般要求望文生义,即是含有业务含义。
如:
FACTORYMANAGER
2、表的命名一般为大写,也可以适当使用单词的缩写,但是第一个单词一般不为缩写。
3、单词之间也可以使用下划线链接。
如:
TEST_RESULT
5.2字段的设计
1、字段的命名也要望文生义和尊重遗留的经验,部分的名称要按照以前的经验去命名。
2、单词之间也可以用下划线链接。
以下常用的命名规则:
时间:
TIME结尾,创建时间CREATETIME,结束时间:
ENDTIME
名称:
NAME结尾用户名标示:
USERID
说明:
INSTRUCTION删除标示:
DELETED
邮箱:
EMILE备注:
MEMO
手机:
PHONE标题:
TITLE
部门:
DEPT结尾内容:
CONTENT
状态:
STATUS结尾
5.3Sql的设计
1、关键字大写:
在SQL语句的编写中,凡是SQL语句的关键字一律大写,如:
SELECT、ORDERBY、GROUPBY、FROM、WHERE、UPDATE、INSERTINTO、SET、BEGIN、END......
2、WHERE条件排序:
在SQL语句的编写中,WHREE条件中有主键的,主键排在第一位,剩下的字段按照字段在表中的排列顺序进行排列。
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 代码 开发 规范 V01