TSCMS项目-JAVA开发规范.docx

《TSCMS项目-JAVA开发规范.docx》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、中国证券会证券市场客户资金监控系统开发规范JAVA版北京宇信易诚科技有限公司SICMS项目组目录1、Java开发规范31.1、命名规范31.1.1、文件File31.1.2、包Package31.1.3、接口Interface31.1.4、类Class41.1.5、方法Method41.1.6、参数Parameter41.1.7、变量Variable51.1.8、实例变量InstanceVariable51.1.9、常量Constant51.1.10、数组Array51.2、格式规范61.2.1、注释Comment61.2.2、缩进Indentation71.2.3、空格Space

2、71.2.4、空行BlankLine81.2.5、行长度LineLength81.2.6、换行NewLine91.2.7、圆括号Parentheses91.2.8、大括号BigBrackets91.3、语句规范101.3.1、简单语句SimpleStatement101.3.2、条件语句ConditionStatement101.3.3、分支语句SwitchStatement111.3.4、循环语句LoopStatement111.3.5、包和引入语句PacketandImportStatement121.3.6、声明语句DeclareStatement121.3.7、例外控制语句

3、ExceptionControlStatement131.3.8、类和接口ClassandInterface131.3.9、方法Method141.3.10、属性Attribute141.3.11、SQL语句SQLStatement161.4、配置文件规范161.4.1、配置文件161.5、日志规范161.5.1、日志规范Logger161、Java开发规范1.1、命名规范122.11.1.1、文件File命名规范是否必须遵循范例文件名命名方法,单词首字母大写必须Org.java数据层访问文件以DAO结尾必须IUserDAO数据层访问实现文件以Impl结尾必须UserDAOImpl

4、业务层访问文件以BS结尾必须IUserBS业务层访问实现文件以Impl结尾必须UserBSImpl控制层访问文件以UCC结尾必须UserUCC控制层访问实现文件以Impl结尾必须UserUCCImpl页面访问层实现文件以BB结尾必须UserBB1.1.2、包Package命名规范是否必须遵循范例采用项目缩写必须以cn.sicms开头Package名称小写必须Package名称必须为单数必须使用:cn.sicms.common不使用:cn.sicms.commons1.1.3、接口Interface命名规范是否必须遵循范例英语单词字头大写,其他可以用大写或小写必须User接口要I开头

5、必须IUser1.1.1、类Class命名规范是否必须遵循范例英语单词字头大写,其他可以用大写或小写必须UserBean1.1.2、方法Method命名规范是否必须遵循范例第一个英文单词首字母小写必须openAccount()类的获取方法的方法名采用被访问的字段名前加上前缀get必须getFirstName()getLastName()类的设置方法的方法名采用被访问的字段名前加上前缀set必须setFirstName()setLastName()类的布尔型的判断方法要求方法名使用单词is做前缀或者使用具有逻辑意义的单词必须isPersistent()isString()类的普通方法

6、采用完整的英文描述说明成员方法功能，并尽可能是动+名形式。必须openFile()addAccount()1.1.3、参数Parameter命名规范是否必须遵循范例参数的名字必须和变量的命名规范一致必须thisAClassParameter使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字建议setCounter(intsize){this.size=size;}1.1.1、变量Variable命名规范是否必须遵循范例变量的名字必须以一个小写字母开头，后面的单词用大写字母开头必须usernamethisIsAClassVariable循环记数变量通常采用i,j,k或者

7、counter建议i,j,kcounter1.1.2、实例变量InstanceVariable命名规范是否必须遵循范例变量的名字必须以一个小写字母开头，后面的单词用大写字母开头必须usernamethisAClassInstance1.1.3、常量Constant命名规范是否必须遵循范例常量的名字必须都大写，下划线分隔必须finalstaticintDEFAULT_HTTP_PORT=801.1.4、数组Array命名规范是否必须遵循范例数组的名字必须参照示例命名必须