JAVA命名规范课件.docVIP

JAVA 命名规范 Java-开发命名规范 所有的程序开发手册都包含了各种规则。 一些习惯自由程序人员可能对这些规则很不适 应，但是在多个开发人员共同写作的情况下， 这些规则是必需的。 这不仅仅是为了开发效率 来考虑，而且也是为了后期维护考虑。 命名规范 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的， 增加可读性， 减少 项目组中因为换人而带来的损失。 （这些规范并不是一定要绝对遵守， 但是一定要让程序有 良好的可读性） . ( Package ) 包的命名 Java 包的名字都是由小写单词组成。但是由于 Java 面向对象编程的特性，每一名 Java 程 序员都可以编写属于自己的 Java 包，为了保障每个 Java 包命名的唯一性，在最新的 Java 编程规范中， 要求程序员在自己定义的包的名称之前加上唯一的前缀。 由于互联网上的域名 称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前 缀。 例如： net.frontfree.javagroup ( Class ) 类的命名 类的名字必须由大写字母开头而单词中的其他字母均为小写；如果类名称由多个单词组成， 则每个单词的首字母均应为大写例如 TestPage ；如果类名称中包含单词缩写，则这个所写 词的每个字母均应大写，如： XMLExample,还有一点命名技巧就是由于类是设计用来代表对 象的，所以在命名类时应尽量选择名词。 例如： Circle 方法的命名 方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。 例如： sendMessge 参数的命名 参数的命名规范和方法的命名规范相同， 而且为了避免阅读程序时造成迷惑， 请在尽量保证 参数名称为一个单词的情况下使参数的命名尽可能明确。 Javadoc 注释 第 1 页 JAVA 命名规范 Java 除了可以采用我们常见的注释方式之外， Java 语言规范还定义了一种特殊的注释，也 就是我们所说的 Javadoc 注释，它是用来记录我们代码中的 API 的。Javadoc 注释是一种多 行注释，以 /** 开头，而以 */ 结束，注释可以包含一些 HTML标记符和专门的关键词。使用 Javadoc 注释的好处是编写的注释可以被自动转为在线文档， 省去了单独编写程序文档的麻 烦。 例如： /** * This is an example of * Javadoc * * @author darchon * @version 0.1, 10/11/2002 */ 在每个程序的最开始部分， 一般都用 Javadoc 注释对程序的总体描述以及版权信息， 之后在 主程序中可以为每个类、接口、方法、字段添加 Javadoc 注释，每个注释的开头部分先用 一句话概括该类、接口、 方法、 字段所完成的功能，这句话应单独占据一行以突出其概括作 用，在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以 Javadoc 注释标签开头的特殊段落，例如上面例子中的 @auther 和@version ，这些段落将在 生成文档中以特定方式显示。 变量和常量命名 变量命名的方法采用匈牙利命名法，基本结构为 scope_typeVariableName ，它使用 3 字符 前缀来表示数据类型， 3 个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个 单词组成的名字， 而且每个单词的首写字母大写， 其它字母小写， 这样保证了对变量名能够 进行正确的断句。 例如，定义一个整形变量，用来记录文档数量： intDocCount ，其中 int 表明数据类型，后 面为表意的英文名， 每个单词首字母大写。 这样， 在一个变量名就可以反映出变量类型和变 量所存储的值的意义两方面内容，这使得代码语句可读性强、更加容易理解。 byte 、int 、 char 、long 、float 、 double 、boolean 和 short 。 变量类型和首字母对照关系如下表： 数据类型 / 对象类型 / 变量前缀 / 备注 byte bye 第 2 页 JAVA 命名规范 char chr float flt boolean bln 做布尔变量时，使用 bln Integer/int int String str Single sng short sht Long/long lng Double/double dbl Currency cur Variant bln astr obj vnt 做布尔变量用时， 用 bln ，做字符串数组用时， 用 astr ，做为对象使用时，用 obj ，不确定时，用 vnt 。 对于数组， 在数据类型的前缀前再增加一个 a，例如字符串数组为 astr