Day10-JavaDoc

Day10-JavaDoc

JavaDoc介绍

JavaDoc：

Javadoc 是 Java 语言提供的一种文档生成工具。它从 Java 源文件中的特定注释------JavaDoc注释（以/**开始，以*/结束）提取信息，并根据这些注释生成 HTML 格式的 API 文档。这些文档用于描述类、接口、方法、字段等程序元素的功能、用法、参数、返回值等诸多细节信息。

Javadoc 注释的标签：

• @author：作者名。

• @version：版本号。

  @since：指明需要最早使用的 jdk 版本。

  @param：参数名。

  @return：返回值情况。

  @throws：异常抛出情况。

JavaDoc生成

package com.liu.www.basic;

/**
 * @author liu
 * @version 1.0
 * @since
 */

public class Doc {

    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }

1.命令行生成

D:\IDEA\example\JavaSE\Basic Grammar\src\com\liu\www\basic>javadoc -encoding UTF-8 -charset UTF-8 Doc.java

这是一个在命令提示符或终端中执行的命令，用于为特定的 Java 源文件生成API文档。

具体解释如下：

• “D:\IDEA\example\JavaSE\Basic Grammar\src\com\liu\www\basic>”是当前命令执行的路径，表示命令提示符或终端当前所在的目录是这个路径。

• “javadoc”是用于生成 Java API 文档的工具。

• “-encoding UTF-8”指定输入源文件（即 Java 源文件）的编码为 UTF-8，确保能够正确处理可能包含非 ASCII 字符的源文件内容。

  “-charset UTF-8”通常指定生成的文档的字符编码为 UTF-8，保证生成的文档中的字符能正确显示和被不同的系统和工具处理。

  “Doc.java”是要生成文档的 Java 源文件的名称。这个命令会读取“Doc.java”文件中的文档注释，并生成相应的 API 文档。

• 默认情况下，执行上述 javadoc 命令后，会在与 Doc.java 文件所在的目录（也就是 D:\IDEA\example\JavaSE\Basic Grammar\src\com\liu\www\basic）下存放生成的API文档。你可以直接进入该文件夹，然后找到其中的 index.html 文件，使用浏览器打开这个文件，就能查看以 HTML 格式呈现的完整 API 文档了。javadoc工具会将从 Java 源文件注释中提取的信息（如类的描述、方法的功能、参数、返回值等），以 HTML 格式组织起来生成文档。index.html是这个 HTML 文档集合的入口文件，通过浏览器打开index.html后，你会看到一个完整的、带有目录结构和超链接的 API 文档界面。

总结：

javadoc 参数 Java文件

2.IDEA里面生成

（暂时不写）