JAVA注释

java语言中有3中注释方法

1.单行注释

//这是单行注释

/*
*这里是多行注释
*/

/**
*这里是文档注释
*/

如何使用javadoc生成api文档

文档注释以/**开头*/结尾，中间的内容即为注释内容，可以被提取到api文档中

如：

package aaa;
/**
*@author kanzaki.com
*@version 1.0
*/
public class Test{
	/**
	*成员变量
	*/
	private int age;
	/**
	*构造器
	*/
	public static void test(){

	}
}

1.通过命令行窗口进入源文件所在路径

2.运行javadoc指令   javadoc 选项 源文件or包

javadoc的选项主要有以下几种：

-d<directory> 指定生成的api文档存放的目录

-windowtitle<text> 指定打开的api文档在浏览器中显示的标签

-doctitle<html-code> 指定api文档的概述页面的标题

-header<html-code> 指定api文档的页眉

如：

javadoc -d apidoc -windowtitle 这是api的windowtitle -doctitle 这是api文档的doctitle-header 这是api文档的headerTest.java

以上命令就可以为所在盘符下的Test.java源文件生成api文档，如果使用*.java，则是将该目录下的所有的java源文件

注：如果要显示作者和版本则需要添加-author和-version

如：

javadoc -d apidoc -windowtitle 这是api的windowtitle -doctitle 这是api文档的doctitle-header 这是api文档的header -author -version Test.java

常用的javadoc标记有以下几种：

1.@author 程序的作者说明

2.@version 源文件的版本说明

3.@param 方法的参数说明

4.@deprecated 不建议的使用方法

5.@return 方法的返回值的说明信息

6.@see 参见，用于指定参考内容

7.@exception 抛出的异常类型

8.@throws 抛出的异常

可以出现在类或者接口文档注释中的：@see，@deprecated，@author，@version等

可以出现在方法和构造器中的有： @see，@deprecated，@param，@return，@exception，@throws等

可以出现在成员变量中有：@see，@deprecated等

java中标识符

标识符规则

java语言中标识符必须以（_），（$），字母开头

标识符可以由 _，$，字母，数字组成，其中数字不能开头

标识符不能还有空格

标识符不能是java关键字或保留字

标识符不能含有除$符号外的任何特殊字符

java关键字