javadoc文档

doc

/**---------------*/是为支持jdk工具javadoc.exe而特有的注释语句

javadoc工具能从java源文件中读取该注释，并能识别注释中用@标记的特殊变量，制成heml格式的类说明文档

javadoc不但能对一个java源文件生成注释文档，而且能对目录和包生成交叉链接的html格式的类说明文档。

@author  ------作者名

@version------版本标识

@parameter--------参数名及其意义

@since -----------最早出现的jdk版本

@return------------返回值

@throws --------异常类及抛出条件

@deprecated-------引起不推荐使用的警告

使用alt+shift+j-------------->生成注释

例如：

  /**
     * 文件上传.
     * 
     * @param name 文件名
     * @param season 时令
     * @param file 文件
     * @return 上传提示结果
     */

生成javadoc

--------------------------------------------------------

1.选择File-Export-javadoc

2.javadoc command选择JDK的bin目录下的javadoc.exe,选择要生成javadoc的源代码和javadoc的保存路径

3.document title输入标题

4. extra javadoc options输入（额外的java选项）：如果项目采用的编码是utf-8，

需要设定参数：-encoding utf-8 -charset utf-8

否则生成的网页中文注释是乱码