《JAVA代码规范》（一）目的、目录、介绍

转载自：《JAVA代码规范》（一）目的、目录、介绍

http://www.javadt.com/thread-352-1-1.html

《JAVA代码规范》（一）目的、目录、介绍

目的
本文提供一整套编写高效可靠的 Java 代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强灵活性。通过遵循一套通用的程序设计标准，显著提高 Java 软件开发者的生产效率，为开发团队的程序设计带来更大的一致性，使软件开发团队的效率明显提高。

规范的执行
本文档适用于项目组内进行软件开发的所有技术人员，即项目组内软件开发人员编写的所有源代码都必须遵循本规范。
除临时性项目之外的任何项目均应严格按照此标准执行，“临时性项目”指：
为市场推广目的而编写的示程序
为一次性用途而编写的临时性小程序
为学习目的而编写的测试程序

目录
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 注释成员函数和方法 30
7 编程惯例 32
7.1 提供对实例以及类变量的访问控制 32
7.2 引用类变量和类方法 32
7.3 常量 32
7.4 变量赋值 32
8 其它惯例 33
8.1 圆括号 33
8.2 返回值 33
8.3 条件运算符"?"前的表达式 33
8.4 特殊注释 34
9 代码范例 34
9.1 源文件范例 34
10 缩写说明 35
11 参考资料 36

[url=]1       介绍[/url][url=]1.1  为什么要有编码规范[/url]

编码规范对于程序员而言尤为重要，有以下几个原因：

Ø        一个软件产品的80%的生命期是在维护。

Ø        几乎没有一个软件在它的整个生命期里都是被它的作者来维护的。

Ø        使用好的风格提高了软件的可维护性。

Ø        如果源代码和软件产品是捆绑给客户的，作为产品的剩余部分，它应该有好的分包（well-packaged），足够清晰和专业的代码。

转载请注明：http://javadt.com