Java教程

【Java】(三)JavaDoc生成

本文主要是介绍【Java】(三)JavaDoc生成,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!

文章目录

  • JavaDoc
  • 使用命令行生成JavaDoc文档
  • 使用IDEA生成JavaDoc文档

JavaDoc

百度获取的:JDK1.8官方帮助文档
javadoc是用来生成自己API文档的技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。

参数信息:
@author作者名
@version版本号
@since指明需要最早使用的jdk版
@param参数名
@return返回值情况
@throws异常抛出情况

通过输入"/**+回车"编写JavaDoc:

package base;

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

public class Demo01 {
    public static void main(String[] args) {
        System.out.println(10086);
    }
}

使用命令行生成JavaDoc文档

1.选中文件→鼠标右键→打开文件名目录
在这里插入图片描述
2.导航栏cmd打开命令行
在这里插入图片描述
3.输入命令“javadoc -encoding UTF-8 -charset UTF-8 xxx.java”编译生成JavaDoc文档
在这里插入图片描述

使用IDEA生成JavaDoc文档

1.打开 IDEA,点击生成JavaDoc文档
在这里插入图片描述
2.填写配置并生成
在这里插入图片描述
3.首页"index.html"
在这里插入图片描述

这篇关于【Java】(三)JavaDoc生成的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!