java开发规范文档
说明:文章内容仅供预览,部分内容可能不全。下载后的文档,内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的,是否完整无缺。
一千零一夜产品部 系统开发规范V1.0 一千零一夜途遇科技有限公司 2015-11-03 修改记录 版本号 V1.0 修改人 刘伟 修改内容 规范第一版 目录 1 2 3 4 前言 ........................................................................................................................ 4 开发管理 ................................................................................................................ 4 项目周期 ................................................................................................................ 4 命名规范 ................................................................................................................ 5 4.1 4.2 4.3 4.4 4.5 项目编号命名规范 .................................................................................................... 5 文档命名规范 ............................................................................................................ 5 路径管理 .................................................................................................................... 5 jsp/html命名规范 ..................................................................................................... 6 数据库命名规范 ........................................................................................................ 8 表名规范 ............................................................................................................ 8 字段规范 ............................................................................................................ 8 4.5.1 4.5.2 5 6 文档规范 ................................................................................................................ 8 代码规范 ................................................................................................................ 9 6.1 Java源代码规范 ........................................................................................................ 9 命名 .................................................................................................................... 9 代码格式 .......................................................................................................... 11 注释 .................................................................................................................. 12 其他 .................................................................................................................. 13 6.1.1 6.1.2 6.1.3 6.1.4 6.2 6.3 jsp/html代码规范 ................................................................................................... 13 数据库开发规范 ...................................................................................................... 15 主键 .................................................................................................................. 15 日期类型 .......................................................................................................... 16 固定字段 .......................................................................................................... 16 取值规范 .......................................................................................................... 16 数据库开发工具 .............................................................................................. 16 6.3.1 6.3.2 6.3.3 6.3.4 6.3.5 6.3.6 6.4 Sql书写规范 .................................................................................................... 17 其他规范 .................................................................................................................. 17 Java源代码规范 ...................................................................................................... 18 java代码命名与格式 ....................................................................................... 18 7 实战代码规范 ...................................................................................................... 18 7.1 7.1.1 7.2 jsp/html代码规范 ................................................................................................... 26 Logic类中新增数据方法怎么写 ............................................................................. 29 Logic类中修改数据方法怎么写 ............................................................................. 30 Logic类中删除数据方法怎么写 ............................................................................. 31 怎样创建一个没有底部按钮的窗口 ...................................................................... 32 怎样设置弹出窗口的标题 ...................................................................................... 32 怎样重写提交数据的方法 ...................................................................................... 33 怎样创建单grid的页面.......................................................................................... 33 怎样多个页签的grid的页面 .................................................................................. 34 怎样创建左边树右边grid的页面 .......................................................................... 34 8 FAQ ...................................................................................................................... 29 8.1 8.2 8.3 8.4 8.5 8.6 8.7 8.8 8.9 9 代码检查规定 ...................................................................................................... 34 10 附录1:JPA使用指南 javax.persistence的注解配置 .................................. 34 1 前言 为了使软件开发过程有章可循,保证软件质量,加强开发管理。 2 开发管理 3 项目周期 公司项目开发周期分为以下几个步骤: 文档名称 说明 撰写人 是否可选 备注 需求分析 完成对用户系统的需求分析 对项目工作量进行详细评估,配备相应的开发、测试、实施人员 指定项目的开发计划,指定到人 需求说明书 需求分析人必选 根据项目规模员 和要求详细程度可以有所不同。 Demo 各个模块的详开发人员 必选 根据项目规模细页面Demo 和要求详细程度可以有所不同。 开发计划 标记各个模块项目经理 必选 到周,到人 的开发计划 测试计划 测试计划 测试人员 必选 根据项目情况详细情况可以不同 测试用例 测试人员 可选 根据项目情况选用 开发阶段 各计划阶段时间点的执行情况 每周进行总结 项目执行情况 项目经理 必选 项目经理填写说明 标准格式的文每周个人总结 系统提交测试报告 测试报告 实施阶段 验收报告 项目阶段性提交给项目 项目组成员 项目经理 测试人员 必选 可选 档 初期在贵阳项目试行 项目经理 必选 4 命名规范 4.1 项目编号命名规范 4.2 文档命名规范 4.3 路径管理 路径结构如下: 项目名称 |_database(数据库数据) |_docs(文档) |_参考文档(项目参考文件) |_需求&设计(需求文件及各种设计文档) |_开发计划 |_软件测试 |_部署&培训 |_工作汇报 |_trunk(主目录) |_WebRoot(应用文件) |_src(源代码) |_业务模块一(某一个功能分类,如工具类) |_com.navinfo.分类英文名 (源代码目录) | |_entity (数据模型) |_logic (逻辑实现类) |_services (逻辑接口层) |_action (Action层) |_utils(当前功能的工具类或常量定义) |_ |_spring/ (spring的配置文件) |_hibernate/ (hibernate的配置文件) |_struts/ (struts的配置文件) |_quartz/ (quartz的配置文件) 注,红色字体的部分和原有规范不同,主要是业务模块和配置文件放在同一个根目录下,为防止eclipse的配置顺序导致源代码和配置文件分离的很远。 |_业务模块二 |_...... 示例: 图:Src路径 4.4 jsp/html命名规范 jsp与html文件名全部小写,并遵循如下的规范: 数据/内容显示页 名词,多个单词用下划线分隔,要求能说明显示内容的信息,为避免冲突,可加上 "_list"。例如: new_message.html 或 my_file_list.jsp 操作处理页 命名格式:名词_下划线_动词,例如:file_delete.jsp。 图:Jsp命名 含frame页面 中的name属性命名的格式是①xxx._②xxx_③xxx ①xxx部分用来标识当前页面隶属于整个系统中的哪一功能模块。 如:属于ebwebmail则被表示为ebwebmail,其它情况依次类推。 ②xxx部分标识当前页面所要完成的功能。 如:完成用户登录的功能则被标识为login,其它情况依次类推。 ③xxx部分用来用来表示页面在浏览器窗口所处的位置。 处于浏览器窗口的顶部则标识为top,其它情况依次类推。 例如:ebwebmail_inbox_top.jsp src属性相应的文件名根据情况建议在原命名规范上用下划线加上所处窗口的位置。 javascript脚本方法 脚本函数都以①xxx_②xxx的方式命名。 ①xxx对应页面隶属的模块。 ②xxx表示函数所要实现的功能(动宾结构),多个单词用下划线连接。 例如:ebwebmail_send_mail() 模块通用的脚本函数必须集合于一个js文件中,在页面上通过形式导入。js文件名命名使用模块名,例如:ebwebmail.js。 如果项目已经提供了公共js脚本,则优先使用公共js脚本中提供的函数。 所有定义方法的元素定义在中或