package lee;
/**
* @author shanglangaoshou
* @version 1.0
*/
public class JavadocTest
{
/**
* 简单测试Field
*/
protected String name;
/**
* 主方法,程序的入口
*/
public static void main(String[] args)
{
System.out.println("Hello World!");
}
}
常用javadoc 标记有:
@author
@version
@deprecated 不推荐使用的标记
@param 方法的参数说明
@return
@see 参见
@exception 抛出异常的类型
@throws 抛出的异常
javadoc 常用的选项有:
-d 指定一个路径
-windowtitle 指定API文档的浏览器窗口标题
-doctitle 指定概述页面的标题。
-header 每个页面的页眉
所以 :
执行 javadoc -d . -author -version *.java
|