NB@SCRCU_Java编码规范.doc

键入文字 NBSCRCU_项目Java编码规范 模板修订历史版本生效时间变更概要作者审核批准0.52007-7-12创建本模板汤轶阳 目录键入文字1.概述61.1目的61.2使用范围62.进入时机63.参与人64.输入/输出65.程序代码的结构顺序66.文件大小77.语句的说明78.空白行的使用79.注释710.缩进811.命名规范812.工具813.编程惯例813.1提供对实例以及类变量的访问控制813.2引用类变量和类方法913.3常量913.4变量赋值913.5其它惯例913.5.1圆括号913.5.2返回值913.5.3条件运算符?前的表达式1013.5.4特殊注释101. 概述1.1 目的指导开发人员的Java编码格式,有效进行Java编码。1.2 使用范围本文档使用读者范围为NBSCRCU_全体开发人员。2. 进入时机编码阶段3. 参与人开发人员4. 输入/输出输入：详细设计输出：格式化后Java代码 5. 开发工具 开发工具备注Eclipse V？ 交互平台开发工具 移动应用平台开发工具 能力中心开发工具6. 软件版本软件版本版本号JDK7. 开源框架系统框架备注主体框架Spring mvc3.X日志框架Log4j2脚本框架JQuery定时框架spring-quartz1.6.58. 工程编码utf-89. 程序代码的结构顺序1.package声明package com.palic.xxxx;2.import声明import java.io.*;3.类或接口的注释说明/* * 类或接口的功能说明 * 类或接口的使用说明 * * author 作者信息 * version v1.0 * CreateDate: yyyy-mm-dd * * * UpdateUser:修改人名称 * UpdateDate:yyyy-mm-dd * UpdateRemark:修改具体的内容； */4.类或接口的声明public class xxx （如果含有public类，应作为第一个类来声明）5.类的静态变量声明顺序为public, protect, private;例如：public static int aB;protect static String cD;private static List eF;6.实例变量声明顺序为public, protect, private例如：public int aB;protect String cD;7.构造函数public ClassName extend Object implements Interface (parameters ) .8.类的方法根据需要来定义和实现。每个类要有注释说明，参见注释部分10. 命名规范一般规则使用可以准确说明变量/字段/类的完整的英文描述符采用该领域的术语。采用大小写混合，提高名字的可读性。尽量少用缩写，但如果一定要使用，就要谨慎地使用避免使用长名字（最好不超过 15 个字母）避免使用相似或者仅在大小写上有区别的名字。避免使用下划线作为名字的首末字母。1.文件命名文件名命名方法, 单词首字母大写，如 ThisIsTest.java2package命名以所在域的域名颠倒的顺序开始使用小写字母 如包名备注com.scrcu.ebank.cportal.*门户com.scrcu.ebank.mportal.*移动门户com.scrcu.ebank.ecc.*交互平台com.scrcu.ebank.ebc.*能力中心com.scrcu.ebank.uim.*统一认证 3class和interface命名使用名词或组合词，第一个字母大写 如class Raster;使用描述性的词语，避免使用缩写 如 class ImageSprite;接口要I开头 如ISomeInterface4变量使用混合词，第一个字母小写。不能以下划线或$开头。如 float myWidth；避免使用一个字母的变量命名，除非是临时变量使用c、d、e来命名临时字符变量 如char c;使用 i、j、k、m、n来命名临时整型变量 如 int i;4方法动词或者混合词 第一个字母小写，末尾词第一个字母大写 如run(); runFast();类的获取方法的方法名采用被访问的字段名前加上前缀get如：getFirstName()，getLastName()类的设置方法的方法名采用被访问的字段名前加上前缀set如：setFirstName()，setLastName()类的布尔型的判断方法要求方法名使用单词 is 做前缀或者使用具有逻辑意义的单词 如：isString()，equal()类的普通方法采用完整的英文描述说明成员方法功能，并尽可能是动+名形式。openFile()，addAccount()5常量全部使用大写字母，单词之间使用下划线 如 static final int MY_WIDTH= 4;11. 格式规范11.1 语句的说明1. 在条件if、循环while、for、do-while、switch和try-catch语句中，代码块的开括号紧跟在条件后，不要