编码规范编写规范.doc

综合征管系统升级改造项目编码规范编写规范编码规范编写规范1. 编编制目的制目的指导软件开发过程编码规范的制定，保证软件产品质量，降低软件开发与维护成本，最大限度满足用户需求2. 适用范适用范围围适用于应用软件开发项目、研发产品开发、产品客户化的编码工作和程序修改3. 文件文件说说明明1、本文为指南性文件，供参考使用文件的主体内容见所附范例在实际使用时，可以：、1、采用本范例规定的格式：只需删除斜体字，并替换成相应的内容即可；、2、或者，参考本范例，根据项目情况酌情改变格式、增加或删减部分内容2、必要时，可另行编制摘要或导读作为编码规范的附件，便于阅读和理解3、在编制过程中，应尽可能多使用实例，以提高文件的可读性综合征管系统升级改造项目变更记录 序号修改单号页号条款号修改人/日期批准人/日期实施日期注：对该文件内容增加、删除或修改均需填写此变更记录，详细记载变更信息，以保证其可追溯性目 录1. 编编制目的制目的.......................................................................................................................................12. 适用范适用范围围.......................................................................................................................................13. 文件文件说说明明.......................................................................................................................................11. 概述概述...............................................................................................................................................42. 代代码码的基本格式的基本格式...........................................................................................................................42.1目录结构............................................................................................................................42.2背景....................................................................................................................................5 2.3代码文本............................................................................................................................53. 标识标识符命名符命名...................................................................................................................................63.1标识符命名基本原则........................................................................................................6 3.2分类标识符命名原则........................................................................................................64. 注注释释...............................................................................................................................................74.1注释规范原则....................................................................................................................7 4.2文件头注释........................................................................................................................7 4.3类与接口注释....................................................................................................................8 4.4函数过程与方法注释........................................................................................................8综合征管系统升级改造项目4.5变量和常量注释................................................................................................................8 4.6流程和算法注释................................................................................................................9 4.7数据结构注释..................................................................................................................10 4.8代码修改注释..................................................................................................................105. 空白空白规规范范.....................................................................................................................................116. 错误错误与异常与异常处处理理.........................................................................................................................117. 其它其它规规范范.....................................................................................................................................11综合征管系统升级改造项目综综合征管系合征管系统统升升级级改造改造项项目目编码规编码规范范文档编号： 版本： 1. 概述概述一个软件的生命周期中，80%的花费用于维护。

为方便将来系统持续改进、升级等过程中代码的可读性和资源的合理利用，避免重复劳动，特制定本次综合征管系统升级改造编码规范，以此文档为参照，统一编码风格，提高编码质量希望项目组各方参与，集思广益，不断改进和完善本规范2. 代代码码的基本格式的基本格式2.1目录结构src\gov\gdlt\taxcoresrc\gov\gdlt\taxeventsrc\gov\gdlt\taxguisrc\gov\gdlt\taxweb2.2背景 描述文件采用的文件名格式规范代码文件名，准确反映该文件中代码的主要功能 规范代码文件名前后缀，应遵循程序设计语言或开发工具的具体约定2.3代码文本 每行代码字符数量最大 120综合征管系统升级改造项目 代码中的缩进控制长度 4 个字符 开发人员在开发工具生成的代码中附加功能代码时，这些附加的功能代码文本格式应尽量和开发工具生成的代码文本格式统一3. 标识标识符命名符命名3.1标识符命名基本原则1.不使用程序设计语言的保留字，如【B】Next；【J】interface；【I】import 等2.长度不超过程序设计语言的限制一般以不超过 32 个字符为宜3.使用英文或英文缩写，准确表达该标识符的功用。

4.根据各程序开发语言的不同要求，正确使用大小写格式和前缀、后缀等3.2分类标识符命名 详见国家税务总局金税三期项目—编码和命名标准附录 A《JAVA 编码规范》 详见国家税务总局金税三期项目—编码和命名标准附录 B《网站设计技术规范》4. 命名命名规则规则4.1包的命名规则 包的命名以业务框架为准综合征管系统升级改造项目 包的层级要与业务框架的层级一致 包命名时采用中文和英文结合的方式 包的名称首字母必须为小写名称由多个单词组成时，第二组单词首字母应大写4.2类与接口的命名规则 类名采用半角英文字符书写，统一以中文或英文描述，类名简洁而按名知意，可以使用缩略语，采用小写字母命名，每一个单词的首字母大写 接口命名使用 ”I”＋接口名，单纯实现某个接口的类使用接口名＋”Impl”命名4.3JSP、JS 或 GUI 页面的命名规则 类名采用半角英文字符书写，统一以中文或英文描述，JSP 文件名简洁而按名知意，可以使用缩略语，采用小写字母命名 文件命名使用[操作类别]- [功能模块名称].jsp [操作类别]包括录入-insert、修改-update、查询-view4.4常量的命名规则 Java 中，常量，即不变的值，一般用类的静态常量字段来实现。

公认的约定是，采用完整的英文大写单词，在词与词之间用下划线连接示例：MINIMUM_BALANCEMAX_VALUE综合征管系统升级改造项目DEFAULT_START_DATE4.5变量的命名规则 应采用完整的英文描述符来命名字段，以便使字段所表达的意思一目了然象数组或者矢量这样是集合的字段，命名时应使用复数来表示它们代表多值示例：firstNamezipCodeunitPricediscountRateorderItems5. 注注释释5.1注释规范原则 源代码中的注释可以使用中文或英文，但必须准确、完整的描述被注释内容，不产生歧义 源代码中的注释格式要符合程序设计语言的语法要求。