编码规范文档(简化版).docVIP

成都朗沃 朗沃java项目规范要求 【简化版】 （内部数据） Drafter: 张宁 2010-03-14 Confidential—not for Distribution 规范要求： 编号 规范描述 正确范例 错误范例 备注 包命名按照 com.lovo.班级名.小组名.项目名 所有包名小写.其它的包在项目名下进行划分.详细参见C-002 com.lovo.gt02.wt.chartmessge cn.wt.chartmessage Cn.wt.chartMessage 必须遵守 工程目录命名(j2se) 在满足C-001的规范上满足下列包结构： test: 测试包 exception: 自定义异常包 utils或tools:工具包 bean：java数据类包。一般存放和数据库对应的表bean view或ui：和用户界面有关的包 action或control：控制器 dao：存放数据操作类的包 listeners:自定义的事件监听器包 events: 自定义事件包 imp:接口实现包 以上包结构可以在对应的包下再细分层。此规范不对这些进行规定 com.lovo.wt.chartmessge.test 略 必须遵守：保证每个工程必须有这些包结构。即使包里没有对应的类 Dao类必须以Dao结尾 UserInfoDao 过滤器以Filter结尾 LoginFilter 必须遵守 所有的类名、变量名、方法名遵循骆驼命名法： 类名所有首字母大写 方法名、非常量名第一个单词首字母小写以后的每个单词的首字母大写 布尔值使用is打头 所有命名除了常量可以使用_进行单词分隔，均不允许使用任何符号进行单词分隔。 LoginDao String userName; String getUserName() boolean isEmpty Object _object Object _IsEmpty _addAll(), _AddAll(); 必须遵守 ** 抽象类以Abs或Abstract开头 AbstractCollection 略 必须遵守 接口最好能用I开头 interface IInsert 略 非强制性 接口的实现使用Impl结尾。并放到imp包里 class IteratorImpl 略 非强制性 代码{}使用节俭式写法，代码缩进4个字节 interface Interface { String UUID = ; public void showMessage(); } 略 必须遵守 ** 常量使用全大写，并用“_”进行单词分隔 public static final int ISO_B10 = 5; 必须遵守 ** 类名、方法名、变量名不要使用缩写，如果使用缩写，也必须是能正确描述其含义，不能有二义性和增加理解的难度。 AbstractInterruptibleChannel getCompanyNameById String companyName AIChannel getCNameBId String cName 必须遵守 ** 类必须有注释，类注释至少包含一下几项并且使用javadoc注释: 类的功能描述 (必须) 创建人 (必须) 创建时间 (必须) 其它可选项： 公司名（班级名、小组名） 版本号 最后一次修改日期 最后一次修改人 /* * pDescription:该servlet负责登陆验证 /p * @author 张三 *@date: 2008.04.17 */ 略 必须遵守 方法必须有注释，注释至少包含以下几项并且使用javadoc注释： 功能描述 参数说明 返回值说明 异常说明 其它可选项： 创建日期 最后一次修改日期 最后一次修改人 注意： 1如果返回的集合，必须说明集合里存放是对象还是基本类型。并指出类型是什么。 2如果方法抛出异常必须说明在什么情况下会抛出该异常 3 如果方法返回的数据有特殊的格式，要写明格式是什么并举一个例子。如： 例：传入的字符串为,指定分隔符为“”,分隔个数为2. 方法返回,如果传入的分隔个数为4，则方法返回” /** * 提交订单 * * @param orderList * 订单列表 * @return false：提交失败。 true：提交成功 */ public boolean commitOrderInfo(List orderList) 略 必须遵守 变量注释使用单行注释 略 略 必须遵守 ** +、-、*、/、%、=、、、!=、=、= 两边空