Java 命令规范（转载）

最新推荐文章于 2023-11-16 21:17:31 发布

weixin_33777877

最新推荐文章于 2023-11-16 21:17:31 发布

阅读量111

点赞数

文章标签： java python

原文链接：https://my.oschina.net/simon203/blog/121948

版权

2019独角兽企业重金招聘Python工程师标准>>>

出现频率：★★★

解析

在面向对象编程中，对于类、对象变量、方法等的命名是非常有技巧的，例如，大小写的区分，使用不同字母开头等。但究其本，追其源，在为一个资源命名时，应该本着描述性和惟一性两大特征，才能保证资源之间不冲突，并且便于记忆。

1．包的命名

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

例如：net.frontfree.javagroup。

2．类的命名

类的名字必须由大写字母开头，一个单词中的其他字母均为小写。如果类名称由多个单词组成，则建议将每个单词的首字母均用大写，例如TestPage。如果类名称中包含单词缩写，则建议将这个词的每个字母均用大写，如：XMLExample。由于类是设计用来代表对象的，所以建议在命名类时应尽量选择名词。

3．方法的命名

方法的名字的第1个单词应以小写字母开头，后面的单词则建议用大写字母开头。

例如：sendMessge()。

4．常量的命名

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

例如：MAX_VALUE。

5．参数的命名

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

6．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 ，这些段落将在生成的文档中以特定方式显示。

虽然添加注释不会使一个设计低劣的程序变成好的程序，但是如果按照编程规范编写程序，并且为程序添加良好的注释，却可以帮助编写出设计优美、运行高效且易于理解的程序，尤其在多人合作完成同一项目时，编程规范非常重要。俗话说"磨刀不误砍柴工"，花费一点时间去适应一下Java编程规范是有好处的。

答案：如表2.2所示（符合命名规则即可）。

表2.2 变量命名

数据类型	中文含义	作用域	你的命名
Int	序列号	全局范围	globalID
（类）	用户账单	（类）	UserReckoning
String	用户名称	类成员	userName
Float	当月收入	类成员	currentMonHarvest
Static final	最大金额	类成员	MAX_MONEY
Double	罚款	局部变量	smartMoney
（包）	用户	（包）	user