java命名规范
2010-06-05 10:25
246 查看
1.包的命名
Java包的名字都是由小写单词组成。每一名Java程序员都可以编写属于自己的Java包,为了保障每个Java包命名的惟一性,最新的Java编程规范要求程序员在自己定义的包的名称之前加上惟一的前缀。由于互联网上的域名是不会重复的,所以程序员一般采用自己在互联网上的域名作为自己程序包的惟一前缀。
例如:net.frontfree.javagroup。
2.类的命名
类的名字必须由大写字母开头,一个单词中的其他字母均为小写。如果类名称由多个单词组成,则建议将每个单词的首字母均用大写,例如TestPage。如果类名称中包含单词缩写,则建议将这个词的每个字母均用大写,如:XMLExample。由于类是设计用来代表对象的,所以建议在命名类时应尽量选择名词。
3.方法的命名
方法的名字的第1个单词应以小写字母开头,后面的单词则建议用大写字母开头。
例如:sendMessge()。
4.变量和常量的命名
变量采用匈牙利命名法,采用3字符前缀表示数据类型,前缀后面是1个或多个单词,每个单词的第一个字母大写。比如intDocCount。
变量类型与变量命名时的前缀的对照关系如下:
数据类型 变量前缀
byte bye
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。
常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则建议用下划线来分割这些单词。
例如:MAX_VALUE。
5.参数的命名
参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证在参数名称为一个单词的情况下,参数的命名尽可能明确。
6.Javadoc注释
Java除了可以采用常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是通常所说的Javadoc注释,它是用来记录代码中的API的。Javadoc注释是一种多行注释,以/**开头,而以*/结束,注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转化为在线文档,省去了单独编写程序文档的麻烦。例如:
Java包的名字都是由小写单词组成。每一名Java程序员都可以编写属于自己的Java包,为了保障每个Java包命名的惟一性,最新的Java编程规范要求程序员在自己定义的包的名称之前加上惟一的前缀。由于互联网上的域名是不会重复的,所以程序员一般采用自己在互联网上的域名作为自己程序包的惟一前缀。
例如:net.frontfree.javagroup。
2.类的命名
类的名字必须由大写字母开头,一个单词中的其他字母均为小写。如果类名称由多个单词组成,则建议将每个单词的首字母均用大写,例如TestPage。如果类名称中包含单词缩写,则建议将这个词的每个字母均用大写,如:XMLExample。由于类是设计用来代表对象的,所以建议在命名类时应尽量选择名词。
3.方法的命名
方法的名字的第1个单词应以小写字母开头,后面的单词则建议用大写字母开头。
例如:sendMessge()。
4.变量和常量的命名
变量采用匈牙利命名法,采用3字符前缀表示数据类型,前缀后面是1个或多个单词,每个单词的第一个字母大写。比如intDocCount。
变量类型与变量命名时的前缀的对照关系如下:
数据类型 变量前缀
byte bye
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。
常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则建议用下划线来分割这些单词。
例如:MAX_VALUE。
5.参数的命名
参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证在参数名称为一个单词的情况下,参数的命名尽可能明确。
6.Javadoc注释
Java除了可以采用常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是通常所说的Javadoc注释,它是用来记录代码中的API的。Javadoc注释是一种多行注释,以/**开头,而以*/结束,注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转化为在线文档,省去了单独编写程序文档的麻烦。例如:
相关文章推荐
- Java命名规范
- Java基础知识01-命名规范
- java中的变量命名规范
- java命名规范-java编程规范
- Java包(package)的命名规范,java中package命名规则
- Java编码规范,让你的代码赏心悦目--有意义的命名
- Java命名规范
- Java包的命名规范
- java中类名,方法,变量,包名等大小写命名规范
- JAVA项目命名规范
- JAVA的命名规范
- Java项目命名规范
- java、jsp、html命名规范和定义
- 《疯狂Java讲义(第3版)》.(李刚)——java命名规则及编码规范
- Java规范之JNDI(Java命名与目录接口)
- JavaBean中的get/set 的命名规范
- java 命名规范
- java包名命名规范
- Java中自定义标识符的命名规范
- Java~命名规范