Java学习之如何使用idea生成文档

package com.zzz.base;

/**
 * @author zzz
 * @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 ;


    }
}

用/**号加回车键即可自动生成文档注释/**
     *
     * @param name
     * @return
     * @throws Exception
     */

如何使用idea生成文档

1.选择Tools里面的Generate JavaDoc

• 点击上述菜单项后，会出现生成 JavaDoc 的对话框，一般的选项都很直观，不必细说。但是要注意生成 JavaDoc 的源代码对象的选择，一般以模块（Module）为主，必要时可以单独选择必要的 Java 源代码文件，不推荐以 PRoject 为 JavaDoc 生成的源范围。

• 里面有一个 Locale 可选填项，默认可能是英文或者是当前操作系统的语言，既然是国人，建议在此填写 zh_CN，这样生成的 JavaDoc 就是中文版本的，当然指的是 JavaDoc 的框架中各种通用的固定显示区域都是中文的。你自己编写的注释转换的内容还是根据你注释的内容来。

• 还有一个“Other command line arguments:”可选填项，非常重要，是填写直接向 javadoc.exe 传递的参数内容。因为有一些重要的设置，只能通过直接参数形式向 javadoc.exe 传递。这里必须要填写如下参数：

  -encoding UTF-8 -charset UTF-8 

---