二级Java考试辅导教程：1.5java程序规范[2]

文章作者 100test 发表时间 2007:03:10 18:44:52
来源 100Test.Com百考试题网

1.5.2 java编程规范
　　软件开发是一个集体协作的过程，程序员之间的代码是经常要进行交换阅读的，因此，java源程序有一些约定成俗的命名规定，主要目的是为了提高java程序的可读性。
　　包名：包名是全小写的名词，中间可以由点分隔开，例如：java.awt.event.
　　类名：首字母大写，通常由多个单词合成一个类名，要求每个单词的首字母也要大写，例如class HelloWorldApp.
　
　　接口名：命名规则与类名相同，例如interface Collection.
　　方法名：往往由多个单词合成，第一个单词通常为动词，首字母小写，中间的每个单词的首字母都要大写，例如：balanceAccount，　isButtonPressed.
　　变量名：全小写，一般为名词，例如：length.
　　常量名：基本数据类型的常量名为全大写，如果是由多个单词构成，可以用下划线隔开，例如：int YEAR, int WEEK_OF_MONTH；如果是对象类型的常量，则是大小写混合，由大写字母把单词隔开。
　　1.5.3 java帮助文档
　　java中所有类库的介绍都保存在java帮助文档中，程序员在编程过程中，必须查阅该帮助文档，了解系统提供的类的功能、成员方法、成员变量等等信息以后，才能够更好的编程。同时，java开发工具包（JDK）提供了
"java"、"javac"、"javadoc"、
"appletviewer"等命令，在java帮助文档中也对此进行了详细的介绍。java帮助文档是以HTML文件的形式组织，通常是安装在JDK目录下的docs子目录中的index.html文件,所以用浏览器就可以进行查阅。例如JDK是安装在D:\jdk1.3目录下面，则用浏览器打开D:\jdk1.3\docs\index.html文件，就可以看到图1_5_1所示的帮助文档。
　　如果希望查阅JDK的命令，则可以选择"Tool Documentation"，如图1_5_2红字所示。
　　此时浏览器就会把java、javac、javadoc、appletviewer等命令列出来，如图1_5_3。
　　但是大多时时候，我们需要查阅的是类库的文档，因此需要在"D:\jdk1.3\docs\index.html"文件中选择"Java 2 Platform API Specification"，如图1_5_4中红字所示。
　　1.5.4 java注释
　　单行注释：从"//"开始到本行结束的内容都是注释，例如：
　　　　　　　　 //这是一行单行注释
　　　　　　　　 //则是另一行单行注释
　　
　　多行注释：在"/*"和"*/"之间的所有内容都是注释，例如：
　　　　　　　　　/*这是一段注释分布在多行之中*/
　　文档注释：在注释方面java提供一种C/C 所不具有的文档注释方式。其核心思想是当程序员编完程序以后，可以通过JDK提供的javadoc命令，生成所编程序的API文档，而该文档中的内容主要就是从文档注释中提取的。该API文档以HTML文件的形式出现，与java帮助文档的风格与形式完全一致。凡是在"/**"和"*/"之间的内容都是文档注释。例如下面的DocTest.java文件：
　　　　　　　/** 这是一个文档注释的例子，主要介绍下面这个类 */
　　　　　　　public class DocTest{
　　　　　　　　　　/** 变量注释，下面这个变量主要是充当整数计数 */
　　　　　　　　　public int i.
　　　　　　　　　　/* 方法注释，下面这个方法的主要功能是计数 */
　　　　　　　　　public void count( ) {}
　　　　　　　}　 来源：www.examda.com
　　通过在命令行下面运行"javadoc -d . DocTest.java"，就生成了介绍类DocTest的index.html文件，用浏览器浏览结果即可，注意到DocTest.java文件中的文档注释的内容都出现在该index.html文件中。