使用javadoc命令生成API文档

柔情只为你懂 2023-07-04 03:19 13阅读 0赞

**1. 编写代码，并添加注解**

/**
     * test
     * @author admin
     * @version 1.0
     * @since 1.5
     */
    public class APITest {
        
        /**
         * 计算两数的和
         * @param a 整数
         * @param b 整数
         * @return 两数的和
         */
        public int add(int a, int b ){
        
            return a + b;
        }
    }

【注】  
（1）注释要尽可能写的详细；  
（2）注释格式为 **`/**.........*/`** ，而不是 `/*.........*/`

**2.更改编码**

*  可以使用 Notepad++ ，将要生成API文档的类的 `.java` 文件的编码格式改为 `ANSI编码(本地默认编码)`
 *  因为 `.java` 文件默认编码格式可能为 `UTF-8编码` ，**若不修改编码格式，生成的文档可能会有乱码**

**3.使命javadoc命令**  
![在这里插入图片描述][20200207153827729.png]

*  输入 `javadoc 类名.java` 再回车之后，便会生成许多 html 文件，打开其中的 `index.html` 便可看见刚刚生成的文档  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0F1Z2Vuc3Rlcm5f_size_16_color_FFFFFF_t_70]

[20200207153827729.png]: https://img-blog.csdnimg.cn/20200207153827729.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0F1Z2Vuc3Rlcm5f_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200207154434636.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0F1Z2Vuc3Rlcm5f,size_16,color_FFFFFF,t_70

发表评论取消回复

表情：

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

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

相关阅读

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

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

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

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

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

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

相关使用javadoc命令生成API文档

1. 编写代码，并添加注解 / test @author admin @version 1.0 @since 1.5

柔情只为你懂/ 2023年07月04日 03:19/ 0 赞/ 14 阅读

相关 javadoc生成API文档

生成命令 E:\workspace\springbootdemo>javadoc -d E:\workspace\springbootdemo\doc -enco

野性酷女/ 2023年06月24日 08:29/ 0 赞/ 99 阅读

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

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

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

相关生成javadoc帮助文档 ( 使用eclipse. 命令)

invalid LOC header (bad signature) http://blog.csdn.net/she\_withwings/articl

淡淡的烟草味﹌/ 2022年06月05日 11:39/ 0 赞/ 330 阅读

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

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

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

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

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

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

相关 JavaDoc生成API

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

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

相关 IDEA生成JavaDOC文档

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

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