Java语言开发规范.docVIP

目录 TOC \o 1-3 \h \z HYPERLINK \l _To1 目的 PAGEREF _To\h 5 HYPERLINK \l _To2 命名规范 PAGEREF _To\h 5 HYPERLINK \l _To2.1 包(Package)的命名 PAGEREF _To\h 5 HYPERLINK \l _To2.2 类(Class)的命名 PAGEREF _To\h 5 HYPERLINK \l _To2.3 对象(类实例)Object命名 PAGEREF _To\h 5 HYPERLINK \l _To2.4 基本数据类型(Primitive)的变量命名 PAGEREF _To\h 6 HYPERLINK \l _To2.5 常量(Constants)的命名 PAGEREF _To\h 6 HYPERLINK \l _To2.6 参数(Parameter)的命名 PAGEREF _To\h 6 HYPERLINK \l _To2.7 数组(Array)的命名 PAGEREF _To\h 6 HYPERLINK \l _To2.8 方法(Method)的命名 PAGEREF _To\h 6 HYPERLINK \l _To3 Java文件样式 PAGEREF _To\h 6 HYPERLINK \l _To3.1 版权信息格式 PAGEREF _To\h 6 HYPERLINK \l _To3.2 package/import格式 PAGEREF _To\h 7 HYPERLINK \l _To3.3 类方法注释的格式 PAGEREF _To\h 8 HYPERLINK \l _To3.4 实现注释的格式 PAGEREF _To\h 8 HYPERLINK \l _To3.5 未完成(ToDO)的格式 PAGEREF _To\h 10 HYPERLINK \l _To4 代码风格(Code Style) PAGEREF _To\h 10 目的 编码规范对于程序员而言尤为重要，有以下几个原因： - 一个软件的生命周期中，80%的花费在于维护- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 为了执行规范，每个软件开发人员必须自觉遵守该编码规范。为了不使该规范成为你工作的负担，请尽可能使用IDE提供的格式化工具来自动格式化代码。 命名规范 命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码。 包(Package)的命名 包是用来组织类结构的重要机制，好的包结构有利于快速理解模块设计。在Java1.1以前包名是允许大写的，但在Java2之后，包名一律小写。 package的名字必须都是由小写单词组成的。 尽可能使用有英语意义的包名，禁止使用汉语拼音。 避免过长的包名和过深的包层次结构。尽可能使用国际上通过的一些缩写形式，不要自创。如util、dao、dto、form、action、handler、impl、proxy、tag、test等。一个包的范例图： 类(Class)的命名 类名是个名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。尽可能用有意义的单词命名,如:BaseInfo, TreeNode, QuerySet等。 接口的命名必须以I打头，如IValidationRule。 避免过长的类名，使用一些通用的缩写形式。如DefaultOracleDAOImpl。 对象(类实例)Object命名 采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或$开头，尽管这在语法上是允许的。 其他参照类命名的相关约定。 基本数据类型(Primitive)的变量命名 基本数据类型的变量第一个