浦发个贷管理系统-设计说明书-编码规范 v1.0.0.doc

浦发个贷管理系统 设计说明书 编码规范 浦发个贷项目组 2005年3月 目 录 1 程序风格 3 1.1 Eclipse设置 3 1.2 命名规范 3 1.2.1 Package命名 3 1.2.2 Class命名 4 1.2.3 Method命名 4 1.2.4 Variable命名 4 1.2.5 JSP命名 4 1.2.6 命名使用单词 5 1.3 Comments 5 2 程序模板 6 2.1 Action模板 6 2.2 Operation模板 7 2.3 Service模板 9 3 公共程序 13 3.1 系统常量 13 3.2 异常处理 13 3.3 下拉框Getter 13 3.4 日期计算函数 14 3.5 格式转换 14 3.6 公共类和方法 14 3.7 JS公共函数 17 3.8 其它说明 17 程序风格 Eclipse设置 设置Java代码风格： 选择菜单WindowsPreferencesJavaCode StyleCode Formatter，点击Edit，弹出对话框后，选择Comments标签，使Enable comment formatting复选框处于未选中状态。 选择菜单WindowsPreferencesJavaCode StyleCode Templates： 编辑Types的Pattern为： /** * @author yourname * @date ${date} * @desc */ 编辑New Java files的Pattern为： /* * ================================================================== * The Huateng Software License * * Copyright (c) 2004-2005 Huateng Software System. All rights * reserved. * ================================================================== */ ${package_declaration} ${typecomment} ${type_declaration} 命名规范 Package命名 addloanapply??? 加按贷款申请 agentservice??? 办证服务 archive???????? 档案管理 combloanapply?? 组合贷款申请 common????????? 通用模块 coresys???????? 核心接口 creditadjust??? 额度调整 creditapply???? 额度申请 creditauth????? 额度审批使用 custcorp??????? 特约商户 custindv??????? 客户管理 guarantee?????? 权利品管理 inquiryprint??? 查询打印 loanapply?????? 贷款申请 loanauth??????? 贷款审批发放 loancomm??????? 贷款通用模块 parammng??????? 参数管理 postloanalter?? 贷后变更 postloanmng???? 贷后管理 project???????? 合作项目 statistics????? 统计分析 Class命名 类名应该是名词，可以由多个单词组成，每个单词的首字母大写。类名要简单并且有描述性。尽量避免使用只取首字母的缩写词或缩略语（除非缩略语比长格式用得更广，比如说URL或HTML）。 所有Action以Action为后缀，所有Operation以Operation为后缀，所有Service以Service为后缀，所有DAO以DAO为后缀。 Method命名 方法名应该是动词，首字母是小写，后继的每个单词的第一个字母大写。 Variable命名 所有变量和实例都是以小写字母打头，内部的单词的第一个字母大写。变量名不要以下划线（_）或美元符（$）打头，即使这样做是允许的。 变量名应该简短而有意义，尽量不要简写，除非变量名太长了。选择的变量名应该有助于记忆，能使代码阅读者了解变量的含义。除非是临时的局部变量，最好不要使用单字符变量。通常用i、j、k、m、k和n表示整数临时变量；用c、d和e来表示字符临时变量。 一般使用类名作为实例名，只是将首字母改为小写。例如： Bctl bctl = new Bctl(); BctlDAO bctlDAO = DAOUtils.getBctlDAO(); BctlService bctlService = BctlService.getInst