JAVA源代码标准规范.docVIP

JAVA代码规范 (初稿) .4  版本更新信息 本版本创建/修改、维护、同意包含人员以下： 创建/修改者：XX 维护者：XX 同意者：XX 具体版本更新统计如表1-1： 表1-1 版本更新统计 版本号 修改确定日期 修改人 修改位置 修改方法 （AMD） 修改内容概述 V1.0 .4 XX 全部 A 初始版本公布 修改方法：A－增加 M－修改 D－删除  目标 本文提供一整套编写高效可靠 Java 代码标准、约定和指南。它们以安全可靠软件工程标准为基础，使代码易于了解、维护和增强灵活性。经过遵照一套通用程序设计标准，显著提升 Java 软件开发者生产效率，为开发团体程序设计带来更大一致性，使软件开发团体效率显著提升。 规范实施 本文档适适用于企业内进行软件开发全部技术人员，即企业内软件开发人员编写全部源代码全部必需遵照本规范。 除临时性项目之外任何项目均应严格根据此标准实施，“临时性项目”指： 为市场推广目标而编写示程序 为一次性用途而编写临时性小程序 为学习目标而编写测试程序 文档类别 本文档属标准规范类项目限制级文档，未经总经理及总经理授权人员同意，不得提供企业以外人员阅读和使用。 版本更新条件 本文档定时评审时间为每十二个月1月，评审及修订步骤依据SEPG工作规范要求。另外，如遇下列条件可进行评审，并依据评审结果决定是否需要进行修订： 本文档所列引用标准已经更新。 本文档使用者若对本文档有任何评论、提议或意见，请经过企业内部网络发电子邮件给SEPG，所收到电子邮件将会在评审和修订时给充足考虑。 使用对象 本文档使用对象包含： 项目管理者 质量确保人员 软件开发人员  目 录 TOC \o 1-4 \h \z \u 1 介绍 7 1.1 为何要有编码规范 7 2 通用代码格式 7 2.1 文件组织 7 2.2 缩进 8 2.3 行长度 8 2.4 换行 8 2.5 空行 10 2.6 空格 10 2.7 注释 11 2.7.1 注释约定 11 2.7.2 实现注释格式 12 2.7.3 文档注释 13 2.7.4 快速浏览 javadoc 13 2.8 申明 14 2.8.1 每行申明变量数量 14 2.8.2 初始化 14 2.8.3 布局 15 2.8.4 类和接口申明 15 2.9 语句 16 2.9.1 简单语句 16 2.9.2 复合语句 16 2.9.3 返回语句 16 2.9.4 if，if-else，if else-if else语句 16 2.9.5 for语句 17 2.9.6 while语句 17 2.9.7 do-while语句 17 2.9.8 switch语句 17 2.9.9 try-catch语句 18 2.10 SQL 18 3 命名规范 19 3.1 总则 19 3.2 项目命名 19 3.3 命名规则 20 3.4 变量命名机制 20 3.4.1 基础类型变量命名规则：变量类型标识+逻辑名 20 3.4.2 通常常见对象命名规则 21 3.4.3 临时变量命名规则 22 3.4.4 全局变量、组员变量、局部变量命名规则 22 3.4.5 常量命名机制 22 3.5 HTML 元素变量命名机制 22 3.6 JSP 文件命名机制 22 4 类、接口、包和编译单元标准 23 4.1 类标准 23 4.1.1 命名类 23 4.1.2 注释类 23 4.2 接口标准 24 4.2.1 命名接口 24 4.2.2 注释接口 24 4.3 包标准 24 4.3.1 命名包 24 4.3.2 注释包 25 4.4 编译单元标准 25 4.4.1 命名编译单元 25 4.4.2 注释编译单元 25 5 字段标准 （字段/属性） 26 5.1 字段可见性 26 5.2 注释一个字段 26 5.3 使用存取组员方法 27 5.3.1 存取函数可见性 27 5.3.2 一定要初始化静态字段 27 6 组员函数和方法标准 28 6.1 命名函数和组员方法 28 6.2 命名存取组员函数和方法 28 6.3 命名结构函数 29 6.4 组员函数和方法可见性 29 6.5 组员函数和方法参数标准 30 6.5.1 命名参数 30 6.5.2 注释参数 30 6.6