java开发规范文档..docVIP

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