Java程编码规范.docVIP

Java 程序编码规范 目录 一、命名规范 1 1、包的命名 1 2、类的命名 1 3、变量的命名 1 4、方法的命名 2 5、静态变量命名 2 6、参数命名 2 7、异常命名 2 二、注释规范 2 1、类及接口注释 3 2、方法注释 3 3、修改注释 3 4、其它注释 3 三、代码格式规范 3 四、程序结构规范 4 1、组织规范 4 2、类文件的书写规范 4 3、类内部的书写顺序 5 附录：常用命名字典 5 1、常用动词表 5 2、专业名词表 5 一、命名规范 使用完整的英文描述符 ，尽量不使用汉语拼音 采用适用于该领域的术语(参见常用命名字典) 多个单词连写时，中间不要加空格(对于常量，多个单词间用下划线连接) 尽量少用缩写 避免使用长的名字（最好 15 个字母以内） 避免使用类似的名字，或者仅仅是大小写不同的名字 尽量避免使用下划线 1、包的命名 采用完整的英文描述符所有单词小写。finance.budget.ejb; （正确） package com.jincai.goldenFinance.budget.ejb; （错误） 注：有另外一种意见，认为包结构这样组织：[公司名].[项目名].[mvc部分].[对象模块名] package com.jincai.goldenfinance.model.budget; 2、类的命名 采用完整的英文描述符，所有单词的第一个字母大写，其他字母小写。 class BudgetManager （正确） class budgetManager （错误） 3、变量的命名 要求简洁、清晰，意义明确。 采用完整的英文描述符，第一个单词首字母小写，其余首字母大写 （名称过长时，可采用适当的，比较通用的缩写。比如mof表示Ministry of Finance） 多值型变量，如Array、Collection，必须使用复数形式来指出它们多值特性 方法内定义的变量尽量不要与类变量重名或过于相似 一个局部变量仅用来完成一项任务。一个局部变量被用于多个目的，往往会使代码难于理解 对于循环计数变量，可以简单的用i，j等表示，不需要有意义 private String budgetName （正确） private String BudgetName （错误） 4、方法的命名 方法的命名一般采用动词+名词的组合，第一个单词首字母小写，其余首字母大写。 （参见常用命名字典） public void addBudget() （正确） 对于布尔型用单词 is 做前缀。oolean isPersistent() （正确） public boolean isString() （正确） 5、静态变量命名 静态变量的名字应该全部大写，单词之间用下划线连接。 public static final String DATABASE_NAME = “ora”; （正确） 6、参数命名 参数的名字必须和变量的命名规范一致。如果可能的话，使用和要赋值的字段一样的名字： setCounter(int size){ this.size = size; } 7、异常命名 通常使用一个字母e或ex表示异常。 如果想表示该异常属于一个特殊的异常类，可以用别的简写。比如用ce表示CreateException，fe表示FinderException。 二、注释规范 注释应该增加代码的清晰度 保持注释的简洁 在写代码之前写注释 注释出为什么做了一些事，而不仅仅是做了什么 注释应加在被注释对象的上一行，不要放在行末 1、类及接口注释 每个类（接口）前面都要求有说明性注释，格式如下： /**  * 该类的说明性文字 * 作者：张三 2002/11/19 */ 2、方法注释 方法注释应放置在该方法之前。 视方法的复杂程度，可以采用以下两种格式中的一种。 简单的方法可以不加注释。 /** 简单注释 */ /** * 多行注释 * @param 参数名称 参数变量说明 * @return 返回值说明 * @exception 异常名称 异常说明 * @see 与该方法有关联的类 */ 3、修改注释 如果修改了他人或自己代码的重要部分，需要保留原有程序，并增加修改注释： // 修改者 李四 2002.11.19 // 修改内容说明 4、其它注释 为了程序的可读性，有时需要给变量，方法内的关键步骤增加注释，采用如下的形式： // 关键步骤（或者其他）说明 三、代码格式规范 采用代码缩进格式表示层次关系。每次缩进建议采用2个空格，尽量不要保留Tab字