应用软件开发编码规范黑龙江省交通运输信息化建设项目标准规范.PDF

HLJJT 黑龙江省交通运输信息化建设项目标准规范 HLJJT101-2017 应用软件开发编码规范 2017-03-06 发布 2017-03-16 实施 黑龙江省交通运输厅 发布 应用软件开发编码规范 目 次 应用软件开发编码规范 1 1 范围 1 2 规范性引用文件 1 3 开发环境规范 1 4 命名规范 1 5 代码格式规范 2 6 注释规范 2 7 日志规范 3 8 安全规范 4 9 其他规范 5 附录A 6 附录B 15 附录C 23 I 应用软件开发编码规范 应用软件开发编码规范 1 范围 本规范旨在用规范文件的形式，对软件开发过程进行有效的编码规范管理，使得最终的软件产品具 有良好的风格和统一的结构，且使代码可读性强、易维护。 本标准适用于规范软件开发编码工作，并对黑龙江省交通运输信息化建设项目各应用系统软件开发 工作起指导作用。 2 规范性引用文件 下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅所注日期的版本适用于本文 件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。 GB/T20000标准化工作指南 GB/T1.1标准化工作导则 GB/T8567-2006计算机软件文档编制规范 GB/T11457-2006信息技术软件工程术语 GB/T17532-2005术语工作计算机应用词汇 3 开发环境规范 3.1 【强制】使用JavaEE6 框架（有特殊应用需求的除外），JDK 应采用稳定版本，要求使用1.6 或1.7 版本。 4 命名规范 4.1 命名总体原则，在开发过程中包、类、方法、变量的命名应选择有意义的名字，能快速地传达用途。 4.2 类命名，类名应使用名词，各个单词第一个字母大写后续字母小写，应保证准确、简洁且容易理解。 4.3 方法名，方法命名第1 个单词应以小写字母开头，后面各个单词第一个字母大写后续字母小写，应 保证准确、简洁且容易理解。 4.4 变量命名宜使用Camel 命名法。 1 应用软件开发编码规范 5 代码格式规范 5.1 代码格式用空格字符缩进源代码，不要用tab，每个缩进4 个空格。 5.2 单行字符数限制不超过120 个，超出需要换行。 6 注释规范 6.1 代码注释总体原则 代码注释总体原则如下： a) 注释内容应简单、明了、含义准确； b) 描述语言应使用中文； c) 整个应用程序中，应使用一致样式来构造注释； d) 基础的源文件、类（接口）、构造函数、类方法、全局变量、字段、属性都应加注释，其中类、 类属性、类方法的注释必须使用javadoc规范，使用/**内容*/格式，不得使用//……方式； e) 特殊的典型算法、代码结构不明晰处、代码修改部分、代码循环和逻辑分支部分、对外提供的 接口部分都应加注释； f) 配置文件中有涉及到数据库连接串设置、配置项设置的地方需要加注释进行说明； g) 在实际的代码规范中，注释应占程序代码的比例达到20%左右。 6.2 注释格式 注释格式如下： a) 单行注释：//……； b) 块注释：/*……*/； c) 文档注释：/**……*/。 6.3 注释内容 注释内容如下： a) 源文件注释，在每个源文件注释信息应包括：