java命名规范
来源:互联网 发布:仿淘宝商品详情 编辑:程序博客网 时间:2024/06/16 19:41
好的开始时成功的一半,虽然现在说这些话有些晚了,但是养成好的习惯永远不能算太晚!
包的命名 (全部小写,由域名定义)
Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都 可以编写属于自己的Java包,为了保障每个Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。 由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。
例如:net.frontfree.javagroup
类的命名 (单词首字母大写)
根据约定,Java类名通常以大写字母开头,如果类名称由多个单词组成,则每个单词的首字母均应为大 写例如TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是设计用来 代表对象的,所以在命名类时应尽量选择名词。
例如: Graphics
方法的命名 (首字母小写,字母开头大写)
方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。
例如:drawImage
常量的命名 (全部大写 ,常加下划线)
常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词。
例如:MAX_VALUE
参数的命名
参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。
Javadoc注释
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,这 些段落将在生成文档中以特定方式显示。
i、j、k等只作为小型循环的循环索引变量。
· 避免用Flag来命名状态变量。
· 用Is来命名逻辑变量,如:blnFileIsFound。通过这种给布尔变量肯定形式的命名方式,使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。
· 如果需要的话,在变量最后附加计算限定词,如:curSalesSum。
在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是 说,程序中除0,1以外,尽量不应该出现其他数字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含 义。如果一个常量名称由多个单词组成,则应该用下划线“_”来分割这些单词如:NUM_DAYS_IN_WEEK、MAX_VALUE。- java命名规范之java命名规范
- java编码规范--命名规范
- JAVA书写规范、命名规范
- JAVA命名规范
- Java编程命名规范
- Java编程命名规范
- java命名规范
- Java-开发命名规范
- Java命名规范
- Java命名规范
- JAVA命名规范
- Java命名规范
- java 命名规范
- JAVA命名规范
- JAVA命名规范
- JAVA命名规范
- Java的命名规范
- java开发命名规范
- 工欲善其事必先利其器——第二弹HDFS性能压测工具浅析
- 12个Flex常用功能代码
- TCP状态迁移图浅析
- cocos2dx3.0alpha1加载cocostudio编辑的ui
- Js日期选择器并自动加入到输入框中示例代码
- java命名规范
- 工欲善其事必先利其器——第一弹应用MapReduce制作压测利器
- 随机过程及其在金融领域中的应用 第四章 习题 及 答案
- 关于什么是句柄(经典)
- jaspereport
- linux安装JDK
- Hibernate中的cascade、inverse以及mappedBy用法
- IP地址与整形转换 java,python实现
- ActiveX控件在IE中不响应Backspace消息