java开发规范文档

《java开发规范文档》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、一千零一夜产品部系统开发规范V1.0一千零一夜途遇科技有限公司2015-11-03修改记录版本号修改人修改内容V1.0刘伟规范第一版目录1前言42开发管理43项目周期44命名规范54.1项目编号命名规范54.2文档命名规范54.3路径管理54.4jsp/html命名规范64.5数据库命名规范84.5.1表名规范84.5.2字段规范85文档规范96代码规范96.1Java源代码规范96.1.1命名96.1.2代码格式116.1.3注释136.1.4其他136.2jsp/html代码规范136.3数据库开发

2、规范156.3.1主键156.3.2日期类型166.3.3固定字段166.3.4取值规范176.3.5数据库开发工具176.3.6Sql书写规范176.4其他规范177实战代码规范187.1Java源代码规范187.1.1java代码命名与格式187.2jsp/html代码规范268FAQ298.1Logic类中新增数据方法怎么写298.2Logic类中修改数据方法怎么写308.3Logic类中删除数据方法怎么写318.4怎样创建一个没有底部按钮的窗口328.5怎样设置弹出窗口的标题328.6怎样重写提

3、交数据的方法338.7怎样创建单grid的页面338.8怎样多个页签的grid的页面348.9怎样创建左边树右边grid的页面349代码检查规定3410附录1：JPA使用指南javax.persistence的注解配置341前言　为了使软件开发过程有章可循，保证软件质量，加强开发管理。2开发管理3项目周期公司项目开发周期分为以下几个步骤：文档名称说明撰写人是否可选备注需求分析n完成对用户系统的需求分析n对项目工作量进行详细评估，配备相应的开发、测试、实施人员n指定项目的开发计划，指定到人需求说明书需求分

4、析人员必选根据项目规模和要求详细程度可以有所不同。Demo各个模块的详细页面Demo开发人员必选根据项目规模和要求详细程度可以有所不同。开发计划标记各个模块的开发计划项目经理必选到周，到人测试计划测试计划测试人员必选根据项目情况详细情况可以不同测试用例测试人员可选根据项目情况选用开发阶段各计划阶段时间点的执行情况每周进行总结项目执行情况说明项目经理必选项目经理填写标准格式的文档每周个人总结项目组成员必选初期在贵阳项目试行系统提交测试报告项目阶段性提交给项目项目经理可选测试报告测试人员实施阶段验收报告项目

5、经理必选1命名规范1.1项目编号命名规范1.2文档命名规范1.3路径管理路径结构如下:项目名称

6、_database（数据库数据）　

7、_docs（文档）　

8、_参考文档（项目参考文件）　

9、_需求&设计（需求文件及各种设计文档）　

10、_开发计划　

11、_软件测试　

12、_部署&培训　

13、_工作汇报

14、_trunk（主目录）　　

15、_WebRoot（应用文件）　

16、_src（源代码）　

17、_业务模块一(某一个功能分类，如工具类)　

18、_com.navinfo.分类英文名(源代码目录)

19、　

20、_entity(数据模型)

21、_logic(逻

22、辑实现类)　

23、_services(逻辑接口层)　

24、_action(Action层)

25、_utils(当前功能的工具类或常量定义)

26、_

27、_spring/(spring的配置文件)　

28、_hibernate/(hibernate的配置文件)　

29、_struts/(struts的配置文件)

30、_quartz/(quartz的配置文件)注，红色字体的部分和原有规范不同，主要是业务模块和配置文件放在同一个根目录下，为防止eclipse的配置顺序导致源代码和配置文件分离的很远。

31、_业务模块二

32、_......示例：图：Src

33、路径1.1jsp/html命名规范　jsp与html文件名全部小写，并遵循如下的规范：数据/内容显示页　名词，多个单词用下划线分隔，要求能说明显示内容的信息，为避免冲突，可加上"_list"。例如：new_message.html或my_file_list.jsp操作处理页　命名格式：名词_下划线_动词，例如：file_delete.jsp。图：Jsp命名含frame页面　中的name属性命名的格式是①xxx._②xxx_③xxx　①xxx部分用来标识当前页面隶属于整个

34、系统中的哪一功能模块。　如：属于ebwebmail则被表示为ebwebmail，其它情况依次类推。　②xxx部分标识当前页面所要完成的功能。　如：完成用户登录的功能则被标识为login，其它情况依次类推。　③xxx部分用来用来表示页面在浏览器窗口所处的位置。　处于浏览器窗口的顶部则标识为top，其它情况依次类推。　例如：ebwebmail_inbox_top.jspsrc属性相应的文件名根据情况建议在原命名规范上用下划线加上所