Java学习之基础语法（二）

标识符

java的标识符是指程序员自己定义的名称，这些名称泛指：类名、方法名、变量等等。

标识符的命名规则主要有：

1. 可以由字母、数字、_、$组成
2. 数字不能开头
3. 不能使用关键字
4. java是大小写敏感的语言

针对标识符业界默认附加规则有：

1. 见名知义
2. 驼峰命名法

注释 

Java中的注释可用来解释说明程序，辅助排错。

Java中的注释形式有：

1. 单行注释，如：//
2. 多行注释，如：/* */
3. 文档注释，如：/**   */

针对文档注释常用在项目的开发中用来管理开发人员的开发程序的可读性，如：

/** 
*概述性语言描述
*
*@author 张三
*@version V1.0
*/
public class Test
{

    /**
    该类的空参数构造函数。
    */
    private Test(){}

    /**
    获取int数组的最大值。
    @param arr 用于接收一个int类型的数组。
    @return 返回该数组中的最大值。
    */
    public static int getMax(int[] arr)
    {
        int max = arr[0];
        for(int x=1; x<arr.length; x++)
        {
            if(arr[x]>max)
                max = arr[x];
        }

        return max;
    }
    /**
    对int数组进行从小打到的排序。
    @param arr 用于接收一个int类型的数组。
    */
    public static void bubbleSort(int[] arr)
    {
    }
}

一般，在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。然后，你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*)，其中常用的标签如下（详细标签请参考http://www.runoob.com/java/java-documentation.html）：

标签	描述	示例
@author	标识一个类的作者	@author description
@version	指定类的版本	@version info
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation

通过命令  javadoc可进行注释文档管理。

格式如：javadoc -d 文档存放目录 -author -version 源文件名.java

这条命令编译一个名为"源文件名.java"的 java 源文件，并将生成的文档存放在"文档存放目录"指定的目录下，生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略。

示例如下，将上面代码另存为Test文件放在C盘Test文件夹下，并执行命令：

javadoc -d help -author -version Test.java