保持更新--java的成长之路-7-javadoc生成API文档-IDEA

最新推荐文章于 2025-03-27 18:17:22 发布

原创最新推荐文章于 2025-03-27 18:17:22 发布 · 145 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

Java学习专栏收录该内容

14 篇文章

订阅专栏

本文档详细介绍了如何使用IntelliJ IDEA生成JavaDoc。步骤包括设置Locale为zh_CN，指定Other command line arguments以确保UTF-8编码和指定窗口标题，并选择输出位置。通过这个过程，开发者可以创建方便阅读的接口文档。

package com.wang.Base;

/**
 * @author  wang
 * @version 1.0
 * @since 1.8
 */

public class Doc {

    String name;

    /**
     * @author wang
     * @version 1.0
     * @since 1.8
     * @param name
     * @return
     * @throws  Exception
     */
    public String test(String name)throws Exception{

        return name;

    }
}

IDEA–Tools–Generate JavaDoc，

1、里面参数填写：Locale 选填项，建议在此填写 zh_CN，方便中英切换；

2、Other command line arguments是填写直接向 javadoc.exe 传递的参数内容，必须填写参数：-encoding UTF-8 -charset UTF-8 -windowtitle “接口文档1.0” -link http://docs.Oracle.com/javase/7/docs/api

3、output可以选择生成位置。