读书人

【6.1】Java定名规范

发布时间: 2012-10-24 14:15:58 作者: rapoo

【6.1】Java命名规范
定义规范的目的是为了使项目的代码样式统一,使程序有良好的可读性。

尽量用英文单词全称,避免用缩写;避免仅靠大小写区别的标识符;避免下划线(除常量);避免过长;固定数字和固定常量用常量来表示

1、包的命名(小写,唯一域名)

Java包的名字都是由小写单词组成。为保障每个Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。

例如:net.frontfree.javagroup


2、类、接口的命名(单词首字母大写,缩写词每个单词都大写,对象用名词)

类的名字必须由大写字母开头而单词中的其他字母均为小写;

如果类名称由多个单词组成,则每个单词的首字母均应为大写,如TestPage;

如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample;

由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。如:Circle


3、方法的命名(首字母小写)

方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。

最好是 动词 + 名词

例如:sendMessge


4、常量的命名(大写,下划线分割)

常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词。例如:MAX_VALUE

关于常量的命名方法,无论什么时候,均提倡应用常量取代数字、固定字符串。

常量可以集中在程序开始部分定义或者更宽的作用域内


5、参数的命名(与方法相同)

参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。


6、变量的命名

匈牙利命名法:繁琐

首字符应小写。词由大写字母分隔,变量名不应以下划线或美元符号开头

尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。

避免用Flag来命名状态变量;如果需要的话,在变量最后附加限定词,如:First(一组变量中的第一个)、Last(一组变量中的最后一个)、Next(一组变量中的下一个变量)、Prev(一组变量中的上 一个)、Cur(一组变量中的当前变量)

例如:inputFileSize。

读书人网 >编程

热点推荐