基础课程 软件公司开发文档规范 DMIS_开发规范.docVIP

江苏润和软件股份有限公司 DMIS开发规范 PAGE PAGE 28 版本/状态 修改日期 修改内容 评审 0.0.1 2008- 初版 DMIS开发规范 版 本 历 史 目录 TOC \o 1-3 \h \z \u DMIS开发规范 1 概述 3 1. 项目配置 3 一、从CVS上检出项目 3 二、安装JDK 5 三、安装tomcat 5 四、安装eclipse 5 五、工程启动 5 六、设置工程编码 6 2. 项目开发相关程序路径 8 3. checkstyle 8 4. 自动格式化工具 15 5. findbugs 24 6. 变量名命名规则 26 7. 生成代码框架 27 8. 共通设计文档位置 28 9. 框架设计文档位置 28 10. 注释 28 11. TODO 29 12. 废代码，警告, 硬代码 30 13. 国际化 30 14. Message信息 30 15. 异常的分类 30 16. Log 30 17. js的导入 31 18. css的规范 31 19. jsp的字符集 31 20. Tab页 31 21. 导航条 32 22. 查询条件的保留 32 23. 分页 32 24. 并发处理 32 25. 列表画面的展示 33 26. 创建人、创建时间、更新人、更新时间 33 27. 排序的规则 33 28. 查询条件、存入数据库中的字段必须过滤 33 29. 查询的结果集 33 30. combox加提示 33 31. 删除标志 34 32. 事务处理 34 33. sqlmap文件的位置、命名方法 34 34. 数据权限、Report对象 34 35. JSP的共通画面的区分 35 36. Session使用规则 35 37. 响应时间 35 38. SQL语句的编写规范 35 概述 本手册用于DMIS项目开发阶段，作为开发阶段的准则。也可作为开发Leader进行Review的参考。 项目配置 一、从CVS上检出项目 项目的开发路径不能跟cvs的项目路径相同。 开发路径：D:\\worksrc\ Cvs路径：D:\ \cvslocal\dmis 参见dmis_doc\B0 Environment\DMIS_工程开发环境建立说明.doc 从cvs上检出dmis_src 图（一） 图（二） Eclipse导入 二、安装JDK Jdk使用3版本 安装文件路径： \\pc722\dmis_开发\DMIS-开发环境\jdk-1_5_0_13-windows-i586-p.exe 三、安装tomcat 文件路径： \\pc722\dmis_开发\DMIS-开发环境\apache-tomcat-6.0.14.tar.gz 将文件解压到目录d:\worksrc 修改tomcat的配置文件，打开D:\worksrc\apache-tomcat-6.0.14\conf\server.xml 文件 在最后倒数第4行的 /Host 上面加一句： Context docBase=D:\worksrc\dmis_src\dmis path=/dmis reloadable=false debug=1 /Context 四、安装eclipse 文件路径： \\pc722\dmis_开发\DMIS-开发环境\eclipse_europa.rar 将文件解压到目录d:\worksrc 改版本eclipse已经设置好java代码的格式和checkStyle， 在开发过程中只要使用快捷键 CTRL+ALT+F 就可以进行代码格式化 五、工程启动 设置ecliose中的tomcat路径，如下图所示： 图标说明： 启动Tomcat 重启Tomcat 关闭Tomcat 启动tomcat后，可以打开浏览器， 输入地址： http://localhost:8080/dmis/Demo1003_Init.do 查看示例页面 六、设置工程编码 设置项目编码，如图(一) 图（二） 七、merge工具 参见文件： \\run-public\Public\Tool\Merge\Araxis Merge\merge6.5SetupGuide.doc 项目开发相关程序路径 \\pc722\dmis_开发\DMIS-开发环境 checkstyle 开发人员需要安装checkstyle检查工具，并对checksty