JAVADOC有关命令简析

JAVADOC 相关标记：

@author ->标记作者

@version ->标记软件版本

@deprecated ->标记不建议使用

@param ->标记参数信息

@return ->标记返回值信息

@exception ->标记异常信息 等

1、创建软件包lin 和 zero

2.在lin 包中添加Test.java和TestJavaDoc.java文件

Test.java:

package lin;
/**
*description：
*<p>
*This program  is designed to create JavaDoc;
*</p>
*
*@see code.lin
*@version 1.0
*@author Zero Lin;
*/
public class Test
{
	/**
	*属性变量值
	*/
	public int number;

	/**
	*@param main函数命令行参数
	*@return 无返回值
	*/
	public static void main(String[] arges){
		System.out.println("hello world!");
	}
}

TestJavaDoc.java:

package lin;
/**
*<br/>CopyRight 2015-,
*<br/>This program is protected by mine laws;
*<br/>Program name:
*@author Zero.Lin forestsummit@163.com
*@version 1.0
*/
public class TestJavaDoc
{
	/**
	*类属性变量
	*/
	protected String name;

	/**
	*构造函数
	*@param 字符串变量参数
	*/
	public TestJavaDoc(String name) {
		this.name = name;
	}
}

3、在Zero 中添加TestTag.java文件；

TestTag.java:

package zero;
/**
*@author Zero.Lin forestsummit@163.com
*@version 1.0
*<p>
*created in 2015
*/
public class TestTag
{
	/**
	*输出字符串“hello world ”的方法
	*@return 放回String类型值
	*/
	private String showWord(){
		String word = "hello world";
		System.out.println("hello world");
		return word;
	}
}

4.打开cmd 命令窗口，切换到 包 lin 和 zero所在的目录；

5.编写命令javadoc -d apidoc -windowtitle 测试 -doctitle 学习javadoc文档测试 -header 自定义类 -version -author lin zero；

-d 指定API文档名与路径

-windowtitle  指定标签名

-doctitle 指定概述中的标题名

-header 指定文档右上名称

-version -author 分别指定版本和作者

最后生成如下：

6、如果需要增加包的描述信息 需在包的根目录下编写package.html文件。