使用Javadoc生成API文档步骤

浅浅的花香味﹌ 2024-04-17 18:10 32阅读 0赞

1.配置好Java环境变量，  
2.编写好一个Java程序，OK，准备工作已完成。  
我的测试类文件保存在 C:\\Users\\90383\\Desktop\\JavadocTest 文件夹下，内容如下：

/**
     * 测试类
     */
    public class Test2 {
    
    	/**
    	 * 变量
    	 */
    	public String str;
    
        /**
         * 构造器
         *
         */
    	public Test2() {
    	}
    
        /**
         * 程序入口
         * @param args 入参
         */
    	public static void main(String[] args) {
    
    	}
    
    	/**
    	 * 测试方法
    	 * @param str 入参
    	 * @return 返回数据
    	 */
    	public String method1(String str){
    
    		return "我日";
    	}
    }

打开cmd交互框：切换到所在文件夹，  
`cd C:\Users\90383\Desktop\JavadocTest`  
使用Javadoc生成API文档的关键命令如下：

javadoc -d apidoc -windowtitle 测试 -doctitle 学习 javadoc 工具的测试API文档 -header 我饿header *.java  -encoding utf-8 -charset utf-8

如此，就完成了API文档的生成，内容和样式如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0dlcnJ5UnVu_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0dlcnJ5UnVu_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/88a7dbdc5a494d2bae1414d3c4800d2f.png

发表评论取消回复

表情：

评论列表（有 0 条评论，32人围观）

还没有评论，来说两句吧...

相关阅读

相关【JAVA】javadoc，如何生成标准的JAVA API文档

一文详解如何使用JAVADOC来生成标准JAVA API文档。

待我称王封你为后i/ 2024年05月02日 20:14/ 0 赞/ 28 阅读

相关使用Javadoc生成API文档步骤

.配置好Java环境变量， 2.编写好一个Java程序，OK，准备工作已完成。我的测试类文件保存在 C:\\Users\\90383\\Desktop\\Jav...

浅浅的花香味﹌/ 2024年04月17日 18:10/ 0 赞/ 33 阅读

相关使用javadoc.exe生成Java api文档

1.javadoc.exe 是 JDK 中的一个命令行工具，可以根据代码中的文档注释自动生成 API 文档。使用 javadoc.exe 生成 API 文档的步骤如下： 1.

喜欢ヅ旅行/ 2024年03月16日 12:31/ 0 赞/ 10 阅读

相关 Android Studio中利用JavaDoc生成项目API文档

1. 在Android Studio中的菜单项中点击Generate JavaDoc ![Image 1][] 2.如果你的项目中有以“UTF8”做编码的j

雨点打透心脏的1/2处/ 2022年08月13日 19:41/ 0 赞/ 144 阅读

相关使用eclipse生成javadoc帮助文档

方式一： 1.首先，打开Eclipse，在需要生成Javadoc的项目上右击鼠标，在弹出来的列表中点击”Export“选项。 ![Center][] 2.

雨点打透心脏的1/2处/ 2022年07月15日 07:17/ 0 赞/ 182 阅读

相关如何使用eclipse生成javadoc帮助文档

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。下面将在eclipse中详细操作，如何生成javadoc

待我称王封你为后i/ 2022年06月04日 00:25/ 0 赞/ 263 阅读

相关使用javadoc生成项目的帮助文档

项目的帮助文档更有利于他人对项目的使用。可以通过cmd命令行和exlipse集成的javadoc功能两种方式制作帮助文档。 cmd命令方式，是使用的是jdk自带的工具，j

「爱情、让人受尽委屈。」/ 2022年05月30日 05:18/ 0 赞/ 233 阅读

相关 JavaDoc生成API

一、综述 1.简介 Javadoc是Java自带的一种工具，其可以从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只

深藏阁楼爱情的钟/ 2022年05月26日 22:29/ 0 赞/ 211 阅读

相关 eclipse如何为java项目生成API文档、JavaDoc

当我们的项目很大，编写了很多代码的时候，就需要生成一个标准的API文档，让后续的开发人员，或者合作者可以清晰的了解您方法的使用，那么如何将自己的项目生成API文档呢？ 1、点

野性酷女/ 2022年03月26日 14:18/ 0 赞/ 347 阅读

相关 IDEA生成JavaDOC文档

IntelliJ IDEA 12.1.6，本身提供了很好的 JavaDoc 生成功能，以及标准 JavaDoc 注释转换功能，其实质是在代码编写过程中，按照标准 JavaDoc

爱被打了一巴掌/ 2021年09月24日 03:24/ 0 赞/ 362 阅读