1. 代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。   
  2. 代码编写规范使用范围:J2EE项目开发。   
  3.  
  4. 包命名规范:   
  5. 目的:包的命名规范应当体现出项目资源良好的划分   
  6.  
  7. servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet   
  8. 例如:net.linkcn.web.servlet   
  9.  
  10. 自定义标签类所在包命名规范:公司名称.开发组名称.项目名称.web.tags   
  11. 例如:net.linkcn.web.tags   
  12.  
  13. 过滤器类所在包命名规范:公司名称.开发组名称.项目名称.web.filter   
  14. 例如:net.linkcn.web.filter   
  15.  
  16. Action类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.action   
  17. 例如:net.linkcn.web.struts.action   
  18.  
  19. ActionForm类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.form   
  20. 例如:net.linkcn.web.struts.form   
  21.  
  22. Javabean所在包命名规范:公司名称.开发组名称.项目名称.web.struts.service.impl   
  23. 例如:net.linkcn.web.service.impl   
  24.  
  25. Javabean实现接口命名规范:公司名称.开发组名称.项目名称.web.service   
  26. 例如:net.linkcn.web.service   
  27.  
  28. DAO类所在包命名规范:公司名称.开发组名称.项目名称.dao.impl   
  29. 例如:net.linkcn.dao.impl   
  30.  
  31. DAO类所实现的接口在包中命名规范:公司名称.开发组名称.项目名称.dao   
  32. 例如:net.linkcn.dao   
  33.  
  34. POJO类与hbm文件所在包命名规范:公司名称.开发组名称.项目名称.dao.hbm   
  35. 例如:net.linkcn.dao.hbm   
  36.  
  37. 全局公共类、接口类所在包命名规范:公司名称.开发组名称.项目名称.global   
  38. 例如:net.linkcn.global   
  39.  
  40. 全局工具类所在包命名规范:公司名称.开发组名称.项目名称.util   
  41. 例如:net.linkcn.util   
  42.  
  43. 类命名规范   
  44. 基本命名规范:   
  45.  
  46. 类、接口命名   
  47. 命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写   
  48. 例如:StudentInfo   
  49.  
  50. 接口命名   
  51. 命名规范:以大写字母"I"开头,如果有多个单词,每个单词头字母大写   
  52. 例如:IStudentInfo   
  53.  
  54. 接口实现类命名:   
  55. 命名规范:将实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。   
  56. 例如:StudentInfoImpl   
  57.  
  58. J2EE+SSH框架命名规范   
  59.  
  60. servlet类命名:   
  61. 命名规范:以Servlet单词结尾   
  62. 例如:LoginServlet   
  63.  
  64. POJO命名:   
  65. 使用hibernate自动生成的类即可   
  66.  
  67. DAO类命名:   
  68. 使用hibernate自动生成的类即可   
  69.  
  70. Action类命名:   
  71. 命名规范:Action的命名以POJO名称来制定,POJO名称Action   
  72. 例如:   
  73. 一个POJO名称为Diary,其对应的action为DiaryAction   
  74.  
  75. ActionForm类命名:   
  76. 命名规范:ActionForm的命名以POJO名称来制定,POJO名称Form   
  77. 例如:   
  78. 一个POJO名称为Diary,其对应的actioForm为DiaryForm   
  79.  
  80. 业务逻辑接口命名:   
  81. 命名规范:业务逻辑接口的命名以POJO名称来制定,IPOJO名称Service   
  82. 例如:   
  83. 一个POJO名称为Diary,其对应的业务逻辑接口为IDiaryService   
  84.  
  85. 业务逻辑实现类命名:   
  86. 命名规范:业务逻辑接口实现类的命名以POJO名称来制定   
  87. 例如:   
  88. 一个POJO名称为Diary,对应的业务逻辑接口实现类名为DiaryServiceImpl   
  89.  
  90. 类变量命名:   
  91. 命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单 词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。   
  92. 例如:   
  93.  
  94. private int studentAge;   
  95. public int getStudentAge(){   
  96.     return studentAge;   
  97. }   
  98. public void setStudentAge(int studentAge) {   
  99.     this.studentAge=studentAge;   
  100. }   
  101.  
  102. 常量命名:   
  103. 命名规范:所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而  且该变量必须是公共、静态、final类型   
  104. 例如:public static final String USER_NAME=”userName“;   
  105.  
  106. 方法命名   
  107. 命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母  大写,单词与单词之间不要使用"_"做连接。单词不要使用名词。   
  108. 例如:public int checkLogin(String name,String pwd){}   
  109.  
  110. 注释规范:注释规范是整个开发规范中最为重要的组成部分,必须严格执行。   
  111. 类的注释:   
  112. 作用:注释整个类,简单概述该类作用。   
  113. 书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基  本作用,作者,日期,版本,公司名称,版权声明。   
  114. 格式:   
  115.  
  116. /* *   
  117. * 类功能描述:(大致描述类的功能)   
  118. * @author:编写者名称   
  119.  
  120. * @version: 类文件的版本号 从1.0开始(自己确定版本号的增改   
  121. * 情况), 修改情况(修改时间、作者、改动情况)   
  122.  
  123. * @see 包名.参考类名 (列出父类,引入类,每个类占一行),如果有   
  124. * 可省略   
  125. * 相关数据如:(便于理解本类的一些常量数据及某些数据的格式   
  126. * 或认为比较重要的数据,如果没有可省略)   
  127. */   
  128. 类的声明语法   
  129.  
  130. 例如:   
  131.  
  132. /**   
  133. * <p>Title:管理员模块数据处理类 </p>   
  134. * <p>Description: 两个数相加</p>   
  135. * <p>Copyright: Copyright (c) 2007</p>   
  136. * <p>Company:华腾软件公司</p>   
  137.  
  138. * @author 童金虎   
  139.  
  140. * @version $Revision: 1.7 $ $Date: 2007/07/08$   
  141. */   
  142. public class AdminDAO   
  143.  
  144.  
  145.  
  146. 变量、常量注释:   
  147. 作用:简单描述该变量的意义。   
  148. 书写规范:变量注释必须写在变量定义之前,简单描述其代表的意义。   
  149. 格式:   
  150.  
  151. /**   
  152.   * 变量功能描述:(大致描述变量的功能)   
  153.   */   
  154.  
  155. 例如:   
  156.      
  157. /**   
  158. *定义年龄变量   
  159. */   
  160. public int age;   
  161.  
  162. 方法注释:   
  163. 作用:对该方法功能简单描述,其参数、返回值意义的注解。   
  164. 书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单  描述,方法的参数、返回值类型、返回值意义简单的描述。   
  165. 格式:   
  166.  
  167. /**   
  168.    * 方法功能说明   
  169.    * @param args (参数类型可以写在参数后,也可以省   
  170.    * 略。每个参数占一行)   
  171.    * @return 输出参数(多种情况写在同一行)   
  172.    * @see 类#参考方法 (与此方法有调用关系的方法供参   
  173.    * 考,不必每个方法都完整列出,要选择有意义的,每个   
  174.    * 方法占一行)   
  175.    * @exception 异常处理类(方法中能够引发的异常,每   
  176.    * 个异常占一行)   
  177. */   
  178.  
  179. 例如:   
  180.  
  181. /**   
  182.   * 修改管理员密码   
  183.   * @param adminId 管理员编号   
  184.   * @param oldPassword 旧密码   
  185.   * @param password 新密码   
  186. * @return boolean 是否编辑成功   
  187.   * @throws UserException   
  188.   * @throws ServiceException   
  189.   */   
  190. public booleaneditAdminPassword(int adminId,String oldPassword,   
  191. String password) throws UserException,ServiceException;   
  192.  
  193. Jsp页面命名:   
  194. 命名规范:jsp页面名称要以小写字母开头,如果有多个单词组成,后面的单词以  大写字母开头。名称要体现出该页面的意义,最好能够与模块名称联系在一起。   
  195. 例如:   
  196. login.jsp  --登录页面   
  197. register.jsp   --注册页面   
  198. message.jsp  --客户留言页面   
  199.  
  200. J2EE项目工程文件夹组织规范:   
  201. 目的:规范学员web应用程序的资源组织形式,形成良好的文件组织习惯。文件的组织形式应当体现模块的划分。   
  202. 根据eclipse工具的特征,项目的目录结构为:   
  203.  
  204. src   
  205.     ----存放java文件    
  206. WebRoot   
  207. |--p_w_picpaths     --存放web程序所需的公共图片   
  208. |--css         --存放web程序所需的公共样式表   
  209. |--js    --存放web程序所需的公共js文件   
  210. |--commons   --存放web程序所需的公共文件   
  211. |--功能模块文件夹(存放与某个功能模块相关的资源)   
  212. |--p_w_picpaths  --存放与该功能模块相关的图片   
  213. |--css      --存放与该模块相关的样式表文件   
  214. |--js    --存放与该模块相关的js文件   
  215. |--jsp、html页面   
  216. |--WEB-INF   
  217. |--classes   
  218. |--lib   
  219. |--tld文件   
  220.  
  221. J2EE项目提交规范   
  222. 项目完成时要将项目作为一个产品交付用户,良好的项目组织规范可以使用户可以方便的找寻项目中需要的资源,同时也是一个公司专业性的体现。项目提交时,要按照下列文件格式进行提交。   
  223.  
  224. 项目主文件夹:   
  225. 作用:存放项目其他资源文件。   
  226. 命名规范:时间_班级编号_第X小组。   
  227. 例如:070706_GS2T18_第四小组。   
  228.  
  229. 项目主文件夹下面包括以下文件夹和文件:   
  230. |--src:保存.java文件。   
  231. |--database:保存数据库的脚本文件或者数据库备份文件。   
  232. |--source:保存eclipse工程中WebRoot目录下的所有文件。   
  233. |--depend:保存编译该程序必须依赖的其他jar文件。   
  234. |--javadoc:保存所有类生成的javadoc api文档。   
  235. |--war:保存程序的归档文件   
  236. |--xx.war:已经打包好的工程文件,可以直接运行。   
  237. |--project:保存开发项目原工程代码及文件。   
  238. |--产品说明书.doc:图文方式展现该产品使用方法。   
  239. |--build.xml:ant脚本,用于生成运行的war文件。   
  240. |--项目解说.ppt:进行项目讲解的ppt(ppt仅供在校模拟项目使用,不用于其他商业用途)   
  241.  
  242. 注:一个完整的项目中,数据库必须有一定量的有效的测试数据来支持该程序的运行