Java javadoc使用

java代码

package wu;
/**
* Description:
* 网站: <a href="http://www.crazyit.org">疯狂Java 联盟</a><br>
* Copyright (c), 2001-2020,Wu.zheng<br>
* This program is protected bay copyright laws.<br>
* programe Name:<br>
* Date:<br>
* @author wuzheng
* @version 5.0
*/

public class javadocTest{
	/**
	*简单测试成员变量
	*/
	protected String name;
	/**
	*主方法程序入口
	*/
	public static void main(String[] args){
		System.out.println("Hellow world");
	}
}

package zheng;
/**
* Description:
* 网站: <a href="http://www.crazyit.org">疯狂Java 联盟</a><br>
* Copyright (c), 2001-2020,Wu.zheng<br>
* This program is protected bay copyright laws.<br>
* programe Name:<br>
* Date:<br>
* @author wuzheng
* @version 5.0
*/
public class Test{
	/**
	*简单的成员变量测试
	*/
	public int age;
	/**
	*简单的构造器测试
	*/
	public Test(){
		
	}
}

package wu;
/**
* Description:
* 网站: <a href="http://www.crazyit.org">疯狂Java 联盟</a><br>
* Copyright (c), 2001-2020,Wu.zheng<br>
* This program is protected bay copyright laws.<br>
* programe Name:<br>
* Date:<br>
* @author wuzheng
* @version 5.0
*/
public class JavadocTagTest{
	
	/**
		* 一个得到打招呼字符串的方法
		* @param name 该参数指定向谁打招呼
		* @return 返回打招呼的字符串
		*/
	public String hello(String name){
			return name + ",你好";
		}
}

命令行

javadoc -d apidoc -windowtitle 测试 -doctitle c学习javadoc -header 我的类 -version -author *Test.java

javadoc常用选项

• -d <路径> 将API文档保存到指定路径下
• -windowtitle <文本> 设置文档浏览器窗口的标题
• -doctitle<html-code>指定一个HTML格式文本，用于指定页面标题

javadoc常用标记

@author: 指定作者
@version:指定版本
@deprecated：不推荐使用的方法
@param：方法的参数说明
@return：方法的返回信息说明
@see：指定交叉参考内容
@exception：抛出异常
@throws：抛出异常，和@exception同义

javadoc默认不提取@author和@version，如需提取使用时添加 -version -author