javadoc小白级入门教程

最新推荐文章于 2022-05-20 14:12:27 发布

火石桥霍建华

最新推荐文章于 2022-05-20 14:12:27 发布

阅读量466

点赞数

CC 4.0 BY-SA版权

分类专栏：初识Java[一些代码练习] 文章标签： java javadoc

本文链接：https://blog.csdn.net/m0_37220730/article/details/103596339

初识Java[一些代码练习] 专栏收录该内容

4 篇文章

订阅专栏

本文详细介绍了如何使用Java自带的javadoc工具生成API文档，包括环境配置、命令使用及常见错误解决方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、记录在学习java的过程中，第一次使用javadoc开发工具的过程（HelloWorld级别）
2、javadoc在安装完JDK后便存在于JDK目录下的bin文件夹中，配置完JAVA开发环境变量后即可在任意位置的cmd中使用。
3、环境配置[java环境配置](https://blog.csdn.net/m0_37220730/article/details/103585266)

javadoc概念

javadoc位于JDK目录下bin文件夹中，是java自带的API生成工具。
使用条件：包含公共或受保护的类/方法、文档说明的java源文件(*.java)。
命令格式：javadoc -d ~~Filename~~ -author -version ~~source.java~~
其中带 ~~删除线~~ 的部分为命令的变量：
(Filename：javadoc生成的目标文件夹的名字，自定义）
(source.java：以.java为后缀名的目标java源文件)

javadoc使用示例

创建以(.java)结尾的java源文件，内包含公开类、文档说明。

// 这是一行单行注释

/*
	这是多行注释的首行
	这是多行注释的末行
*/

/**
	这是一段文档注释
	注释的内容可以被JDK提供的工具 javadoc 解析，生成网页文件形式的本程序说明文档
	@author Eyttao
	@version v0.0
*/


public class HelloWorld{
	public static void main(String[] args){
		System.out.println("Hello World");
	}
}

打开cmd，输入javadoc命令

javadoc -d HelloJavaFile -author -version "D:\MyProjects\JavaProjects\HelloWorld\HelloWorld.java"

若提示错误信息：【错误: 编码GBK的不可映射字符】，则使用如下命令，指定运行编码方式。（当然也可以在文件中更改源文件的编码方式：utf-8改为ANSI，此错误在使用javac命令时也常出现，解决方式一致）

javadoc -d HelloJavaFile -author -version -encoding UTF-8 "D:\MyProjects\JavaProjects\HelloWorld\HelloWorld.java"

javadoc使用示例

找到生成的Filename文件夹，本例为HelloJavaFile文件夹（javadoc生成文件夹的位置取决于使用javadoc命令时，cmd的当前位置：如本例中的C:\Users\Eyttao>）

javadoc生成文件夹

双击文件夹下的“index.html”文件，即可打开由本java程序生成的API文档

需要注意的地方

一定要事先配置好JAVA环境。点此跳转java环境配置。
注意类的限制方式（如public class xxx{}），否则会提示错误信息“错误 - 找不到可以文档化的公共或受保护的类。”
注意JAVA源文件的编码方式，最好是ANSI格式的编码。若为utf-8,则会提示错误信息“错误: 编码GBK的不可映射字符”。也可参照本文中第2步，通过命令行指定运行编码格式。