系统编码规则文档
- 格式：doc
- 大小：141.00 KB
- 文档页数：11
Rule2：Form-bean的名称与Form类名（不含包名）相同。Action路径为“业务逻辑名Action”
如：
<form-bean name="ProvinceForm" type="com.dpca.view.vendor.form.ProvinceForm" />
<actionname="ProvinceForm" path="/ProvinceAction"scope="request" type="com.dpca.view.vendor.action.ProvinceAction"validate="false">
Rule10:JAVASCRIPT函数名命名规范
doAdd新增操作
doDel删除操作
doMod修改操作
doQuery列表查询操作
doQueryDetail详细信息查询操作
doSort排序
doUpload文件上传
doOpen打开一个新窗口
doClickonclick事件,其余事件触发的函数命名以此类推。
Input属性的值为该ACTION对应的页面。
Rule4：forward的命名规则，首字母小写，如包含多个词，每个词首字母大写；名称应采用有意义的与转向页面相关的词。
例：query：表示转向查询列表页面
add：表示转向新增页面
init：进入页面初始化
update：表示转向修改页面
exportLeabharlann 表示转向导出页面Rule6：页面中逻辑处理部分使用struts标签(logic,bean)。
Rule7：JSP文件本身必须为UTF-8的格式。
Rule8：页面转向尽量使用action去完成，而不要直接转向jsp页面。如果有需要预处理的数据（如下拉框），也尽量通过action完成，而少用jsp:include标签。
Rule9：JSP页面中尽量不要出现JAVASCRIPT语句，而是通过调用相应的JS文件来完成。JS文件命名规则业务名称.js
命名规则：表格名称，例如role_function，表格名称全小写
表格相关索引命名：表格名称_index（1。。。。n），例如：role_function_index1
12.字段命名
命名规则：代表具体含义的单词，例如function_id。
字段采用小写字母，单词间用”_”分隔。
12.1.
程序互相调用规则
查看详细信息功能类型标识：Detail
根据条件查询功能类型标识：Query
导入功能类型标识：Import
功能导出功能类型标识：Export
计算功能类型标识：Match
7.FormBean
命名规则：业务逻辑名+功能类型标识Form，例如ParamQueryForm。
FormBean详细命名规则和Action相同。
8.JSP
JSP画面首字母小写。
查询列表页面的命名规则：业务逻辑名Query.jsp，例如paramQuery.jsp。
新增页面的命名规则：业务逻辑名Add.jsp，例如paramAdd.jsp。
修改页面的命名规则：业务逻辑名Update.jsp，例如paramUpdate.jsp。
查看页面的命名规则：业务逻辑名Detail.jsp，例如paramDetail.jsp。
17.JSP编码规则
Rule1：输入项命名参照formbean中对应属性，如：functionId→功能编码
Rule2：页面上每个TEXT控制项必须参照数据库中对应字段的长度设置最大可输入长度，如客户代号在数据库中为13位元，则：
<input type=”text” name=”provincecode” maxlength=”13”>
Rule3：多表查询最大连接表个数为3，如需超过请告知TL，并在提交工作包时附带说明。
神龙汽车有限公司
企业目录（IDM）
程序编码规范
版本号：1.0
用户代表
组织人员
项目负责人
纬创公司
1.命名规范
1.1.方法命名
2.Service方法命名
业务逻辑类通常定义增、删、改、查业务逻辑，方法的命名规则如下：
新增：doAdd
修改：doUpdate
删除：doDelete
查看详细信息：detail
根据条件查询：query
detail：表示转向查询详细信息页面
22.Service编码规则
Rule1：所有Service继承自com.dpca.framework.service.BaseService。
23.VO编码规则
Rule1：VO请序列化。
24.SQL编码规则
Rule1：SQL语句中尽量不使用DB的函数。
Rule2：多表查询尽量不使用子查询。
* @return 返回值
* @throws FwkException Exception
*/
如果没有参数,返回值,异常,对应的注释行就不写.
变量的注释
/**
*变量的说明
*/
代码行的注释
对主要流程，复杂的程序功能须做简单的说明。
15.JSP的注释
<%--
Provider Wistron ITS
Description: 省份列表查询页面
13.
注释规则
14.类程序的注释
文件头的注释
/**
* 大区参考系SERVICE
* History
* Date (DD/MM/YYYY) Author Description
* -----------------------------------------------------------------------
导出页面的命名规则：业务逻辑名Export.jsp，例如paramExport.jsp。
9.Service
命名规则：业务逻辑名Service，例如ParamService。
Service详细命名规则和Action相同。
10.VO
命名规则：业务逻辑名VO，例如ParamVO。
10.1.数据库相关命名
11.表格命名
18.JAVA程序通用编码规则
Rule1：JAVA单个方法代码行数在150行以内。
Rule2：JAVA类代码行数在2000以内。
Rule3：循环层级在3层以内，如需要超过3层，请和设计人员沟通确认。
Rule4：程序中不允许出现中英文，不允许使用中英文做为等于判断的条件。
19.FormBean编码规则
History
Date (DD/MM/YYYY) Author Description
-----------------------------------------------------------------------
06/11/2007YukiFeng Created
--%>
16.编码规则
*31/10/2007YukiFeng Created
*/
class前的注释
/**
* <p>class Name</p>
* <p>description:类的说明,如select list from table REEQT07(site)</p>
*/
方法前的注释
/**
*方法的说明
* @param 参数说明
导入：doImport
导出：export
计算：math
2.1.变量命名
3.常量
对于类中的常量，常量的名称采用全部大写字母的形式，单词间以下划线“_”间隔，例如USER_PROFILE_KEY。如果该常量为固定值，请将该常量设定为publicstaticfinal属性。
4.临时变量和静态变量
对于这二种变量，命名规则为：“变量类型”+“变量名主体”。
不同模块的Service之间，不允许互相调用。
不同模块需要调用的一些共用的业务逻辑处理，可以放在公用服务的包中，如mon。
系统框架工程的程序请不要随便修改。
系统框架包含事务处理、日志处理、通用工具类等。如果有修改的需要，请向TL提出说明。
ACTION间传值需要传值时，两个相关的ACTION对应的FormBean使用相同的属性名。不允许采用其它方式。
Rule3：form缺省的使用范围是session，如果需要将其限制为request范围内使用，必须要加上scope="request"的属性。
如：
<actionname="ProvinceForm"input="init"path="/ProvinceAction"scope="request" type="com.dpca.view.vendor.action.ProvinceAction"validate="false">
Rule3：必输项的检查（主要是insert及update功能）：数据库中定义不能为空(或设计文档中说明不能为空)的项,在页面表单提交时必须做不能为空的检查。
Rule4：部份输入项须根据需求检查输入内容，如只能输入数字和英文字母。
Rule5：页面的form表单及表单中所有的输入项（包括提交button），全部使用struts的标签。
不对应到数据库表的属性变量名，可用通用的变量名命名规则。
5.1.类命名
通用规则：所有类名的首字母必须大写。
6.Action
Action的命名规则：业务逻辑名+功能类型标识Action，例如ParamQueryAction。
如：
<form-bean name="ProvinceForm" type="com.dpca.view.vendor.form.ProvinceForm" />
<actionname="ProvinceForm" path="/ProvinceAction"scope="request" type="com.dpca.view.vendor.action.ProvinceAction"validate="false">
Rule10:JAVASCRIPT函数名命名规范
doAdd新增操作
doDel删除操作
doMod修改操作
doQuery列表查询操作
doQueryDetail详细信息查询操作
doSort排序
doUpload文件上传
doOpen打开一个新窗口
doClickonclick事件,其余事件触发的函数命名以此类推。
Input属性的值为该ACTION对应的页面。
Rule4：forward的命名规则，首字母小写，如包含多个词，每个词首字母大写；名称应采用有意义的与转向页面相关的词。
例：query：表示转向查询列表页面
add：表示转向新增页面
init：进入页面初始化
update：表示转向修改页面
exportLeabharlann 表示转向导出页面Rule6：页面中逻辑处理部分使用struts标签(logic,bean)。
Rule7：JSP文件本身必须为UTF-8的格式。
Rule8：页面转向尽量使用action去完成，而不要直接转向jsp页面。如果有需要预处理的数据（如下拉框），也尽量通过action完成，而少用jsp:include标签。
Rule9：JSP页面中尽量不要出现JAVASCRIPT语句，而是通过调用相应的JS文件来完成。JS文件命名规则业务名称.js
命名规则：表格名称，例如role_function，表格名称全小写
表格相关索引命名：表格名称_index（1。。。。n），例如：role_function_index1
12.字段命名
命名规则：代表具体含义的单词，例如function_id。
字段采用小写字母，单词间用”_”分隔。
12.1.
程序互相调用规则
查看详细信息功能类型标识：Detail
根据条件查询功能类型标识：Query
导入功能类型标识：Import
功能导出功能类型标识：Export
计算功能类型标识：Match
7.FormBean
命名规则：业务逻辑名+功能类型标识Form，例如ParamQueryForm。
FormBean详细命名规则和Action相同。
8.JSP
JSP画面首字母小写。
查询列表页面的命名规则：业务逻辑名Query.jsp，例如paramQuery.jsp。
新增页面的命名规则：业务逻辑名Add.jsp，例如paramAdd.jsp。
修改页面的命名规则：业务逻辑名Update.jsp，例如paramUpdate.jsp。
查看页面的命名规则：业务逻辑名Detail.jsp，例如paramDetail.jsp。
17.JSP编码规则
Rule1：输入项命名参照formbean中对应属性，如：functionId→功能编码
Rule2：页面上每个TEXT控制项必须参照数据库中对应字段的长度设置最大可输入长度，如客户代号在数据库中为13位元，则：
<input type=”text” name=”provincecode” maxlength=”13”>
Rule3：多表查询最大连接表个数为3，如需超过请告知TL，并在提交工作包时附带说明。
神龙汽车有限公司
企业目录（IDM）
程序编码规范
版本号：1.0
用户代表
组织人员
项目负责人
纬创公司
1.命名规范
1.1.方法命名
2.Service方法命名
业务逻辑类通常定义增、删、改、查业务逻辑，方法的命名规则如下：
新增：doAdd
修改：doUpdate
删除：doDelete
查看详细信息：detail
根据条件查询：query
detail：表示转向查询详细信息页面
22.Service编码规则
Rule1：所有Service继承自com.dpca.framework.service.BaseService。
23.VO编码规则
Rule1：VO请序列化。
24.SQL编码规则
Rule1：SQL语句中尽量不使用DB的函数。
Rule2：多表查询尽量不使用子查询。
* @return 返回值
* @throws FwkException Exception
*/
如果没有参数,返回值,异常,对应的注释行就不写.
变量的注释
/**
*变量的说明
*/
代码行的注释
对主要流程，复杂的程序功能须做简单的说明。
15.JSP的注释
<%--
Provider Wistron ITS
Description: 省份列表查询页面
13.
注释规则
14.类程序的注释
文件头的注释
/**
* 大区参考系SERVICE
* History
* Date (DD/MM/YYYY) Author Description
* -----------------------------------------------------------------------
导出页面的命名规则：业务逻辑名Export.jsp，例如paramExport.jsp。
9.Service
命名规则：业务逻辑名Service，例如ParamService。
Service详细命名规则和Action相同。
10.VO
命名规则：业务逻辑名VO，例如ParamVO。
10.1.数据库相关命名
11.表格命名
18.JAVA程序通用编码规则
Rule1：JAVA单个方法代码行数在150行以内。
Rule2：JAVA类代码行数在2000以内。
Rule3：循环层级在3层以内，如需要超过3层，请和设计人员沟通确认。
Rule4：程序中不允许出现中英文，不允许使用中英文做为等于判断的条件。
19.FormBean编码规则
History
Date (DD/MM/YYYY) Author Description
-----------------------------------------------------------------------
06/11/2007YukiFeng Created
--%>
16.编码规则
*31/10/2007YukiFeng Created
*/
class前的注释
/**
* <p>class Name</p>
* <p>description:类的说明,如select list from table REEQT07(site)</p>
*/
方法前的注释
/**
*方法的说明
* @param 参数说明
导入：doImport
导出：export
计算：math
2.1.变量命名
3.常量
对于类中的常量，常量的名称采用全部大写字母的形式，单词间以下划线“_”间隔，例如USER_PROFILE_KEY。如果该常量为固定值，请将该常量设定为publicstaticfinal属性。
4.临时变量和静态变量
对于这二种变量，命名规则为：“变量类型”+“变量名主体”。
不同模块的Service之间，不允许互相调用。
不同模块需要调用的一些共用的业务逻辑处理，可以放在公用服务的包中，如mon。
系统框架工程的程序请不要随便修改。
系统框架包含事务处理、日志处理、通用工具类等。如果有修改的需要，请向TL提出说明。
ACTION间传值需要传值时，两个相关的ACTION对应的FormBean使用相同的属性名。不允许采用其它方式。
Rule3：form缺省的使用范围是session，如果需要将其限制为request范围内使用，必须要加上scope="request"的属性。
如：
<actionname="ProvinceForm"input="init"path="/ProvinceAction"scope="request" type="com.dpca.view.vendor.action.ProvinceAction"validate="false">
Rule3：必输项的检查（主要是insert及update功能）：数据库中定义不能为空(或设计文档中说明不能为空)的项,在页面表单提交时必须做不能为空的检查。
Rule4：部份输入项须根据需求检查输入内容，如只能输入数字和英文字母。
Rule5：页面的form表单及表单中所有的输入项（包括提交button），全部使用struts的标签。
不对应到数据库表的属性变量名，可用通用的变量名命名规则。
5.1.类命名
通用规则：所有类名的首字母必须大写。
6.Action
Action的命名规则：业务逻辑名+功能类型标识Action，例如ParamQueryAction。
