Java程序规范

gm_jwl

原创：darchon 2002年10月23日 <br> <br>一些同学在学习编程的过程中，十分注意学习编程语言的语法和程序实现所采用的算法，他们编写出来的程序有着额外的功能和不错的执行效率，可是我们却不能称这些程序为一个优秀的程序，这其中一个很重要的原因是他们忽视了一个看似很简单的问题，那就是程序编写的规范。一个程序的编写如果没有遵循编程规范，那么程序会难于被他人（甚至是自己）所理解，为在此之后程序的维护、扩展、重用造成很大困难。JAVA语言作为一种十分强调可移植性和可重用性的面相对象的程序语言，我们在使用它的时候，更应该注意它的编程规范，一旦我们循序了这些规则，我们所编写出来的代码不仅可以自成文档，省去了我们单独撰写程序文档的麻烦，更重要的是，它使得程序更易阅读和维护。<br><br>Java语言的命名规范<br>包的命名 <br>Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性，每一名Java程序员都可以编写属于自己的Java包，为了保障每个Java包命名的唯一性，在最新的Java编程规范中，要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀，例如net.frontfree.javagroup。<br><br>类的命名<br>类的名字必须由大写字母开头而单词中的其他字母均为小写，例如Circle；如果类名称由多个单词组成，则每个单词的首字母均应为大写例如TestPage；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。<br><br>方法的命名<br>方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头,如sendMessge。<br><br>变量的命名<br>变量的命名规范和方法的命名规范相同。<br><br><br>常量的命名<br>常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词，如MAX_VALUE。<br><br><br>参数的命名<br>参数的命名规范和变量的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。<br><br>Javadoc注释<br>Java除了可以采用我们常见的注释方式之外，Java语言规范还定义了一种特殊的注释，也就是我们所说的Javadoc注释，它是用来记录我们代码中的API的。Javadoc注释是一种多行注释，以/**开头，而以*/结束，注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。以下是一个Javadoc注释的例子：<br>/**<br>  * This is an example of<br>  * Javadoc<br>  *<br>  * @author darchon<br>  * @version 0.1, 10/11/2002<br>  */<br><br>在每个程序的最开始部分，一般都用Javadoc注释对程序的总体描述以及版权信息，之后在主程序中可以为每个类、接口、方法、字段添加Javadoc注释，每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落，例如上面例子中的@auther和@version，这些段落将在生成文档中以特定方式显示。<br><br>如果希望在Javadoc注释中插入图片，可以把图象文件放在源代码目录下的docfiles子目录下，然后把图像取名为和类一样的名称，并在名称之后加上数字编号，并在Javadoc注释中加入类似下面的HTML代码：<br>&lt;IMG scr=&quot;doc-files/filename-num.gif&gt;<br><br>虽然为一个设计低劣的程序添加注释不会使其变成好的程序，但是如果按照编程规范编写程序并且为程序添加良好的注释却可以帮助你编写出设计完美，运行效率高且易于理解的程序，尤其是在多人合作完成同一项目时编程规范就变得更加重要。俗话说“磨刀不误砍柴工”，那你为何不花费一点时间去适应一下Java编程规范呢？<br> <br>