1、通过 /**＋回车 就可以开始编写

2、在类之前写的可以添加作者、版本号以及最早指明的版本号 还可以在方法前写参数名、返回值、以及异常抛出情况

☆javadoc常用标识

@author 作者 @version 版本号 @param 参数名 描述 方法的入参名及描述信息，如入参有特别要求，可在此注释。 @return 描述 对函数返回值的注释 @deprecated 过期文本 标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。 @throws异常类名 构造函数或方法所会抛出的异常。 @exception 异常类名 同@throws。 @see 引用 查看相关内容，如类、方法、变量等。 @since 描述文本 API在什么程序的什么版本后开发支持。 {@link包.类#成员 标签} 链接到某个特定的成员对应的文档中。 {@value} 当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。

☆例子

package com.study;
/**
 * @author  Hurtblack 作者名
 * @version  1.0  版本号
 * @since  1.8  指明需要最早使用的版本号
 */
public class DOC {
   String name;

    /**
     *
     * @param name 参数名
     * @return   返回值
     * @throws Exception  异常抛出情况
     */
   public String test(String name) throws Exception
   {
       return name;
   }
}

3、生成JavaDoc文档

①、通过cmd命令在要生成的文件目录下使用cmd命令窗口，输入javadoc命令加文件名

例如(-encoding是编码方式 -charset字符集编码)

javadoc -encoding UTF-8 -charset UTF-8 DOC.java

②通过IDEA来实现

Tools→Generate JavaDoc→调整好参数，选择在需要生成的位置生成就行

注：有中文需要对编码格式进行调整加上 -encoding UTF-8 -charset UTF-8

参数说明

1.Whole project:整个项目都生成文档

2.Custom scope 自定义范围。如下：

（1）project files 项目文件，