先看结果

20190625100617.jpg

package com.cmy.test.util;

import java.time.LocalDateTime;

/**
 * Description: TODO(加点注释吧)
 * <p>
 * date: 2019/6/25 9:55
 * <p>
 * projectName : cmy
 * <p>
 * version : 1.0  <p>
 *
 * @author: rocky
 */
public class JavaDocTestClass {
    private int card;
    private String name;
    private LocalDateTime birthday;

    /**
     * 获取卡号
     * @return 返回卡号
     */
    public int getCard() {
        return card;
    }
    /**
     * 设置名字
     * @param name 名字
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * 这是静态方法注释
     * @return 返回字符串类型的注释
     */
    public static  String testStaticMethod() {
        return "";
    }

    /**
     * 这是常量
     */
    public static final String  LOCAL = "常量";
}

本人用过idea生成的，方法如下：

1.先在idea 配置注释 菜单栏File->settings-> file and Code Templates 找到class 编辑

t.png

添加注释

/**
 *  Description: TODO(加点注释吧)  
 *  <p>
 *  date: ${DATE} ${TIME}
 *  <p>
 *  projectName : ${PROJECT_NAME}
 *  <p>
 *  @version : 1.0  <p>
 *  @author: ${USER}
 */

说明：配置的作用是在创建的时候就自动帮你添加注释了，格式可以按照自己风格设置
作用是为了生成javadoc的时候换行，没有<p> 不会帮你换行显示

2.生成javaDoc

在idea 菜单栏的Tools->generate javaDoc...

javadoc.png

javadoc配置说明.png

输入路径不要写跟目录，要多建一个文件夹，比如C:\doc
配置参数一定要写 -encoding utf-8 -charset utf-8
一些@use @author @version 等这些，如果不想要在文档显示的话可以不勾。
如果注释不规范，会在执行生成javadoc的时候再控制台会有提示，这里就不演示了！！

date:2019-06-25