JAVA--文档注释

文档注释是如何生成

JDK中包含javadoc工具，可以将文档注释由源文件中生成一个HTML文档，方便记录程序信息；

文档注释格式

由“ /** ”开始“ */ ”结束，其中/**......*/中内容以自由文本格式，@开头；

文档注释的位置

在描述的类、接口、方法、构造器、成员字段前面，在其它位置（如：方法内部）是无效的；

文档注释的常用标记

@author：作者

@version：版本

@docroot：文档根目录路径

@deprecated：不推荐使用该方法

@param：方法参数类型

@return：方法返回类型

@see：指定参考的内容

@exception/@throws：抛出的异常

文档注释的HTML文件在eclipse的查找

菜单选择->File->Export->java->javadoc->(下一步选择自己需要导出的，返回目录查看）