[JAVA编程开发学习基础.docVIP

Java编码规范 版本：0.1 Java编码规范 1 版本历史 3 1. 注释规范 3 2. 代码规范 4 3. 代码审查 11 版本历史 作者 日期 版本 描述 李丽锋 2010-7-1 0.1 Java编码规范初始文档 注释规范 注释应该被用来给予代码全局性的概述和代码本身信息，所有的文件都应该包含JavaDoc和实现说明注释 JavaDoc 注释 类注释 文件头注释应该包含产品说明，文件名，网速版权信息，类功能说明及代码编写时间和人员。 /** * * IDC资源管理平台 * * File: aaa.java * * ChinaNetCenter Inc. * Copyright (C): 2010 * * Description: * TODO * * Notes:aaa.java 2010-7-1 下午01:58:31 Administrator *//** * 返回服务器列表信息. * * @param rs result Set * @param columnName clob column name * @return * @throws SQLException */ 成员变量注释 每个成员变量应该有一个有意义的说明 /** * 服务器型号. *///1.获取表单参数 LogonForm logonform = (LogonForm) actionForm; SmmUser userVO = logonform.getUserVO(); //2.验证用户是否有权限登录 ISmmService smmservice = (ISmmService) this .getBean(ISmmService.SMM_SERVICE_BEAN_ID); SmmUser user = smmservice.authenticate(userVO); 代码规范 只能用Tab来缩进代码行，每个Tab代表4个空格在eclipse中。 格式规范： 类 枚举 注释 方法 For each/do while Switch 括号 所有的括号都单独占行，除了数组的初始化 类文件引入 不允许使用通配符“*”，不允许导入无用的类。 import java.util.Collections; import java.util.HashMap; import java.util.Iterator; import java.util.Map; 首先引用jdk类，如果没有使用包内的所有类和接口，则需不许使用通配符。 import javax.servlet.http.*; import javax.ejb.EJBLocalObject; javax排列在java之后 import org.jdom.Document; import org.jdom.Element; import org.jdom.input.SAXBuilder; 然后引用第3方类库 import com.systop.ejbutil.bridge.cmd.*; import com.systop.ejbutil.bridge.event.Event; import com.systop.ejbutil.bridge.state.StateMachine; import com.systop.util.struts.plugin.WebContextRealPath; 最后引用自定义类库。所有引用顺序按字母排列。 命名规约 所有命名均使用字母。 包命名 包命名应该都是小写字母。 包名 = c. + 产品名. + 模块名 类命名 类名首字母大写，类名应该都是名词，多个单词组成的类名应该每个单词首字母大写，保持类名的简单和可描述性，不要使用缩写，除非缩写具有广泛的应用，类如：HTTP，URL Public class AddressBusiness Public class ServerDaoUtil 常量类命名： 包名 = c. + 产品名. + 模块名Constants.java ServerConstants.java 方法命名 方法名应该以动词开头，后加名词，后面的单词应该首字母大写 doExcecute() setJdbcdao() 变量命名 所有的变量名的首字母小写，中间单词首字母大写，常量除外。变量名应该短而有意义 private Integer houseNumberStart; 常量命名： 所有常