项目编码规范10.doc

北京知识产权信息服务平台 编码规范 紫光软件系统有限公司 2010-7-1  修订历史记录 版本 章节 作者 修订类型 日期 修订描述 V1.0 全部 刘丰 A 2010-7-1 新建 *章节：可以是具体章节，也可以是 全部、部分 *修订类型： A-ADDED M-MODIFIED D-DELETED 目 录 1 模块命名约定 4 2 java命名规范 4 2.1 路径命名约定 4 2.2 命名空间 4 2.3 类 5 2.4 方法 5 2.5 常用web控件的命名规则 5 2.6 图片文件命名约定 5 2.6.1 路径命名约定 5 2.6.2 文件命名约定 5 3 数据库命名方案 6 3.1 数据库名称 6 3.2 数据库表名 7 3.3 字段名称 7  目的 此文档的目的是为了规范软件开发过程中所有的产出物的命名、风格、编写方式，以期增加这些产出物的可读性、合理性、规范性。 模块命名约定 ZG系统每个模块对应一个英文全名： 英文全名：要能反映该模块的内容，一般超过15个字母； 表 ZG系统功能模块命名方案 功能模块 英文全名 在线咨询 onlinequestion 文章访问权限 permission 企业信息 enterprise 企业专利 patent 事务提醒 warn java命名规范 路径命名约定 网站文件目录：/web/ 业务逻辑层及实体层目录：/zg/com/模块名称/struts/action/ 数据层：/zg/com/模块名称/model/impl/ /zg/com/模块名称/model/ 类 使用驼峰命名规则 用名词或名词短语命名类。 使用全称避免缩写，除非缩写已是一种公认的约定，如SYS。 方法 使用动词或动词短语命名方法。 使用 Pascal 大小写，例：deletePatentTask ()。 常用web控件的命名规则 控件命名规则，以数据库字段属性进行命名，如：用户名 userName 则在web控制中，对应的属性中，使用userName进行命名。 图片文件命名约定 路径命名约定 系统WEB页面中会用到很多图片，这些图片文件存放于目录：/images下。 文件命名约定 文件名称中只允许用小写的英文字母、数字和下划线； 名称分段表示以“_”隔开各段，各段具体表述如下： 类别_具体含义/数字编号_(次级具体含义/数字编号)_(on mouse状态).后缀 （其中，括号内为可选项。） 类别：见类别索引表 表 类别索引表 标识 描述 超链接 备注 logo 标志图片 可有 banner 用于广告、装饰图案等长方形的图片 可有 icon 带超链接的指示性小图标 有 ico 不带超链接的指示性小图标 无 bullet 不带超链接的标识性小图标 无 bg 背景图片 不可 menu 导航条中链接栏目/功能模块的图片 有 button 操作功能图片 有 title 标题图片 无 pic 装饰用的照片 无 p 其它装饰图片 无 blank 填充表格用单一色块图 无 具体含义： 采用对应英文、汉语拼音或其缩写。在同一系统中表示同一含义的文字要求统一。例如；发送邮件图标命名为 icon_sendmial.后缀 数字编号： 数字编号位数与此类图片个数相对应，位数不够的用0补齐。例如共有200个图标，其中第12个命名为 icon_012.后缀 on mouse状态： 有on mouse 效果时添加 on / off 只在某一特殊页面上出现的一组图片命名方式为：页面名称_编号.后缀。例如：系统登录页的图片可命名为index_01.后缀 后缀对应相应的图片格式。在web页面中通常情况下只使用gif和jpeg两种格式图片，在色数不多的情况下使用gif图片格式；在真彩色图片（例如照片）中使用jpeg格式图片。 数据库命名方案 数据库名称 使用项目名称的缩写，对于本项目数据库名称为：ZG 数据库表名 使用如下规范：<模块简称>_<英文单词> 模块简称： 对应项目的每个功能模块都有一个英文缩写名称，见模块命名方案； 库表内容： 库表的功能名称，如：User 库表类型： User，如：ZG_User PatentTransfer，如：ZG_patentTransfer 字段名称 使用如下规范：<table简称>_<字段简称> table 简称: table name 的缩写 字段简称: 字段意义的简称 Stored Procedure Name：<table name>_<功能名称>，功能名称是所要实现功能的描述 jsp文件的命名 jsp文件的名称由英文单词组成，单词的首字符小写，不推荐使用汉语拼音，如addPerson.jsp j