中小企业网Java编程规范

zskang

贡献于2013-04-28

字数:2861 关键词: Java开发 Java

 卷号 卷内编号 密级 分类:COD 使用者:设计员、实施员 ©KJLINK,2013 中小企业网Java编程规范 Version 1.0 作者:俞成 文档信息 标题:中小企业网Java编程规范 作者: 俞成 创建日期:2013-1-30 上次更新日期: 版本:1.0 部门名称:技术开发部门 文档状态 文档状态 ■草稿□ 正式 文档评审人员 评审时间 修订文档历史记录 日期 版本 说明 作者 2013-1-30 初稿 俞成 目录 1. 简介 1 1.1 目的 1 1.2 范围 1 1.3 定义、首字母缩写词和缩略语 1 1.4 参考资料 1 2. 程序设计标准 1 2.1 包目录结构约定[要求] 1 2.2 通用格式 2 2.3 原代码内注释[要求] 2 2.3.1 Java 注释语句类型 2 2.3.2 文件头注释部分 2 2.3.3 类及接口定义部分 3 类注释例 3 2.3.5语句 3 2.3.3.5.1业务逻辑注释 3 2.3.3.5.2控制结构 3 2.3.3.5.3难或复杂的代码 3 3. 数据[非强制] 4 4. 事务处理 4 5. 数据SQL查询 4 中央研究院Java编程规范 中小企业网Java编程规范 1. 简介 本文提供一个简化的编码规范,以期望用较小的代价改进现有项目的代码可读性与可维护性。 1.1 目的 本文档用于指导编码,并确立起一个易于理解、维护,并同软件过程及过程工具紧密集成的编码约定。 1.2 范围 本文档对中小企业项目适用。 1.3 定义、首字母缩写词和缩略语 1.4 参考资料 2. 程序设计标准 2.1 包目录结构约定[要求] 当前结构 控制层[spring-struts-plug in 实例化] |_________com.kjlink.ahpips.web.action.xx模块 服务层[services 标注 |_________com.kjlink.ahpips.services |_________com.kjlink.ahpips.services.xx模块 (接口定义) |_________com.kjlink.ahpips.services.xx模块.impl (接口实现) 数据存取层(Componet 标注) |________com.kjlink.ahpips.dao |________com.kjlink.ahpips.dao.xx模块 (接口定义) |________com.kjlink.ahpips.dao.xx模块.impl (接口实现) 域对象 |________com.kjlink.ahpips.entity 前后台分离结构[实施时间点待通知] 服务层 |_________com.kjlink.ahpips.web |_________com.kjlink.ahpips.web.frontaction.xx模块 |_________com.kjlink.ahpips.web.backaction.xx模块 Struts 配置文件 Confg.struts |_______backend d5341974193f83c908605a02e9ef64f8.doc Page 中央研究院Java编程规范 |_______front 表示层[忽略] 前台 |____WebRoot |___css |___images |___js |___page 后台 |_____WebRoot\admin |___css |___images |___js |___page 前台发布文件 frontbuild.xml 后台发布文件 backendbuild.xml 前台web.xml frontweb.xml 后台web.xml backendweb.xml 前台调试方法: 将frontweb.xml 复制成web.xml即可 后台调试方法: 将 bakcendWeb.xml 复制成web.xml即可 开发人员具体工作: 将模快action 分别复制到backendaction 目录和frontaction 目录;对于backendaction 目录下的文件,应删除前用到的方法,对于frontaction目录下的文件,应删除后台用到的方法;复制struts-info.xml,struts-project,struts-system.xml 到config.struts.backend和config.struts.front 目录,并修改action 注册 使其各自引用对应目录下的action. 产品发布: 需增加 ant backend 和 ant front 两个 task。 2.2 通用格式 2.2.1使用空白、缩进、行宽控制来增加代码可读性,可通过eclipse format 功能格式化 2.2.2 避免大的文件和浮肿的方法,增加可读性 [目前对于新增代码有此要求] 函数的代码行尽量控制在50行以内 2.3 原代码内注释[要求] 2.3.1 Java 注释语句类型 文件头注释部分 d5341974193f83c908605a02e9ef64f8.doc Page 中央研究院Java编程规范 包及引入部分 类及接口定义部分 2.3.2 文件头注释部分 每个Java源文件必须以一个C语言风格的注释开始,该注释包括文件名,版本信息,日期,变更记录及版权声明。参考格式如下: /* * 项 目:中小企业公共服务平台 * * Content.java * * 版本 1.0 * * 作者: 张三 创建日期: 2013年1月13日 * * Copyright 2012-2013 KJLINK. All Rights Reserved. * * */ 2.3.3 类及接口定义部分 说明该方法的功能、环境、使用方法等所有重要的有助于理解方法的信息,尽可能在其中加入Javadoc标记。 类注释例 /* * 业务功能描述: * 处理逻辑 * -----------------------------------------修订历史------------------------------------------- * 日期: * 内容 */ 2.3.4 方法注释 有返回值的必须加@return标记,有参数的必须对每一个参数加@param标记,有错误的必须加@exception标记,尽量加@see标记。 2.3.5语句 2.3.3.5.1业务逻辑注释 除方法注释以外,在方法内部还需加上注释语句来说明你的工作。目的是使方法更易理解、维护和增强。 建议对业务逻辑采用单行注释 在方法内,一定要说明: 2.3.3.5.2控制结构 说明每个控制结构,例如比较语句和循环。你无须读完整个控制结构内的代码才判断它的功能,而仅需看看紧靠它之前的一到两行注释即可。 d5341974193f83c908605a02e9ef64f8.doc Page 中央研究院Java编程规范 2.3.3.5.3难或复杂的代码 若发现不能或者没有时间重写代码,那么应将方法中的复杂代码详细地注释出来。一般性的经验法则是,如果代码并非显而易见的,则应说明。 比较长的代码, 相应的加 //end if,//end for,//end switch,& 这样的注释加在闭括号所在行的行后,可以使代码更易理解。 3. 数据[非强制] 数据项 单位 数据值 每级缩进 字符数 4 最大行宽 字符数 80 标识符最大字符数 字符数 30 业务逻辑注释的注释率下限 % 30 外部注释的注释率下限 % 100 变量注释的注释率下限 % 80 4. 事务处理 统一控制在services层, 5. 数据SQL查询 禁止SQL拼装,采用?占位模式,防止sql注入 d5341974193f83c908605a02e9ef64f8.doc Page

下载文档,方便阅读与编辑

文档的实际排版效果,会与网站的显示效果略有不同!!

需要 5 金币 [ 分享文档获得金币 ]
0 人已下载

下载文档

相关文档