javadoc命令的用法

经常使用的几个参数:html

-d <directory> :该选项指定一个路径,用于将生成的api文档放于该目录下。java

-windowtitle <text>:该选项用于指定一个字符串,用于设置api文档的标题。api

-doctitle <html-code>: 该选项用于选定一个html格式的文本,用于指定概述页面的标题。code

-header<html-code>:该选项用于选定一个html格式的文本,包含每一个页面的页眉。htm

其余的命令能够经过javadoc -help来得到。文档

一些经常使用的javadoc标记字符串

@author 做者it

@version 版本io

@deprecated 过期的方法exception

@param 参数的内容

@return 返回的内容

@see 用于指定交叉参考的内容

@exception 抛出异常的类型

@throws 抛出异常的类型

相关文章
相关标签/搜索