工程实践项目编码规范.pdfVIP

基于JBPM4 的可在web 网页端自定义的工作流的技术 项目编码规范 版本：1.0.0 2016-05-31 文档历史 序号 版本号 作者 修订 1 1.0.0 周新建 起草 2 1.1.0 周新建 修改内容 Web 网页端自定义工作流技术工程实践小组 中国科学技术大学软件学院(苏州)15 级软设2 班 目录 1 前言 2 1.1 编写目的 2 1.2 读者 2 1.3 试用读者 2 1.4 参考标准 2 2 命名规范2 2.1 项目编号命名规范2 2.2 文档命名规范 2 2.3 jsp/html 命名规范2 2.4 数据库命名规范4 3 文档规范4 4 代 4.1.4 其他 9 4.2jsp/html 代码规范 9 5 项目规范11 5.1 应用程序目录规范11 5.1.1Java 源文件目录11 5.1.2Web 应用程序目录规范 11 6 其他规范12 1 1 前言 1.1 编写目的 本文描述了JAVA 开发中的有关包、类、接口、方法、实例变量、变量和常量的命名规 则，用于规范JAVA 编程过程中的命名和代码书写规范。 1.2 读者 工程实践小组全体成员 1.3 试用读者 适用于开发组所有基于JAVA 开发的项目。 1.4 参考标准 GoogleJava 编码规范 2 命名规范 2.1 项目编号命名规范 命名方式：项目英文/中午拼音名称_开发组编号_序列号 序列号由3 为数字组成，不足的用’0’补齐。 2.2 文档命名规范 命名方式：项目英文/中午拼音名称_文档名称_序列号_编写人名称/编号 2.3 jsp/html 命名规范 1、jsp 与html 文件名全部小写，并遵循如下的规范： a.数据/内容显示页: 名词，多个单词用驼峰形式标识，要求能说明显示内容的信息。 例如： userInfo.html 或 accountList.jsp b.操作处理页 命名格式：名词_动词，例如：fileDelete.jsp。 c.含frame 页面 frameset中frame的name 属性命名的格式是①xxx_②xxx_③xxx 2 ①xxx 部分用来标识当前页面隶属于整个系统中的哪 能模块。 如：属于ebwebmail 模块则写ebwebmail，其它情况依次类推。 ②xxx 部分标识当前页面所要完成的功能。 如：完成用户登录的功能则被标识为login，其它情况依次类推。 ③xxx 部分用来用来表示页面在浏览器窗口所处的位置。 处于浏览器窗口的顶部则标识为top，其它情况依次类推。 例如：ebwebmail_inbox_top.jsp framesrc 属性相应的文件名根据情况建议在原命名规范上用下划线加上所处窗口的位置。 2、javascript 脚本文件命名方式： 脚本函数都以①xxx_②xxx 的方式命名。 ①xxx 对应页面隶属的模块