Day10-JavaDoc

Day10-JavaDoc

JavaDoc介绍

JavaDoc：

javadoc 命令是用来生成自己 API 文档的。

javadoc 是一个工具，它可以读取源代码中的文档注释，并将其转换为格式规范的 API 文档。javadoc 通过解析文档注释中的特定标记，如 @author、@version、@since、@param、@return、@throws 等，来提取关键信息，生成易于阅读和理解的文档。

参数信息：

• @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 源文件生成文档。 具体解释如下： - “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 参数 Java文件

2.IDEA里面生成

（暂时不写）