kooyee ‘s blog

开源软件, 众人努力的结晶, 全人类的共同财富
posts - 103, comments - 55, trackbacks - 0, articles - 66
   :: 首页 :: 新随笔 :: 联系 :: 聚合  :: 管理

[Java优化编程] 1.10 方法、变量与常量的命名规则

Posted on 2007-09-21 22:40 kooyee 阅读(2464) 评论(1)  编辑  收藏 所属分类: Java

1.10  方法、变量与常量的命名规则

关于包、类及接口的命名规则,在上面的章节中已经讲解过,在此就不再赘述了,本节讲解在Java程序设计中,有关方法、变量与常量的命名规则相关的知识。

1.10.1  方法的命名规则

方法一般来说都是动词,第一个字母应该小写,在多个单词混合的情况下,第一个单词后的所有单词的第一个字母大写,其余字母小写,例如下面的代码:

     run();   

runFast();

getBackground();

在方法的声明部分,通常要提供对方法功能的描述,以及方法中返回值与参数的说明,例如下面的代码:

/**

 * 显示系统信息方法

 * @param message 系统信息参数

 * @return message 返回系统信息

 */

 public String showMessage (String message) {

         …

                  // statements;

         

         return message;

 }

如果该方法在软件产品的不断升级中已经不被建议使用了,可以通过在方法声明注释部分添加关键字@deprecated实现。

1.10.2  变量的命名规则

变量的命名规则是,除了变量(variable),所有对象的实例(instance),类(class)与类的常量(constant)的第一个字母应该小写,在多个单词混合的情况下第一个单词后的所有单词的第一个字母大写,其余字母小写的规则之外。变量的第一个字母即使系统允许,也不要为_或者$。变量名字因该紧凑而有意义。变量的名字应该是易记忆、易于理解的,即使间隔较长的时间也可以依其名而知其意。另外单字符的变量名应该尽量避免,除非临时变量,例如,一些整数单字符临时变量:i,j,k,m,n等以及单字符变量:c,d,e等,如下所示的代码:

int  i;

char  c;

float imageWidth;

1.10.3  常量的命名规则

Java中的常量一般采用大写字母单词命名,单词与单词之间用下划线(_)加以分割,这符合ANSI的常量命名规则,如下所示的代码:

static final int MIN_WIDTH = 14;

static final int MAX_WIDTH = 1000;

static final int GET_THE_MEMORY = 128;

&注意  关于关键字static与final的用法,我们将在下面章节做详细的讨论。

上面讨论了Java语言中的代码编写风格及相关格式与书写规则,下面做一个简单Java程序设计的实践,从中掌握所学过的知识。


评论

# re: [Java优化编程] 1.10 方法、变量与常量的命名规则  回复  更多评论   

2007-09-22 00:03 by 千里冰封
不错,挺实用的

只有注册用户登录后才能发表评论。


网站导航: