javadoc生成API文档

野性酷女 2023-06-24 08:29 31阅读 0赞

#### 生成命令 ####

E:\workspace\springbootdemo>javadoc -d E:\workspace\springbootdemo\doc -encoding utf-8  -sourcepath src\main\java -subpackages com

#### 参数选项 ####

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>解释</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-d</td> 
   <td>用来指定生成doc存放的目录</td> 
  </tr> 
  <tr> 
   <td>-encoding</td> 
   <td>用来指定使用什么编码格式进行编码(一般需要指定使用utf-8，不指定就使用默认系统默认编码)</td> 
  </tr> 
  <tr> 
   <td>-sourcepath</td> 
   <td>指定需要执行doc文档的目录</td> 
  </tr> 
  <tr> 
   <td>-subpackages</td> 
   <td>指定需要递归循环的包名</td> 
  </tr> 
 </tbody> 
</table>

#### 常见错误 ####

`src\main\java\com\example\demo\entity\DemoData.java:15: 错误: 编码GBK的不可映射字符`  
出现这个错误就是因为上面没有指定`-encoding utf-8`参数，javadoc使用了默认的系统gbk编码了。

#### 其他参数 ####

javadoc的options选项还挺多的…  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzMTYxODg_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzMTYxODg_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191222135757112.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzMTYxODg=,size_16,color_FFFFFF,t_70

发表评论取消回复

表情：

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

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

相关阅读

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

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

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

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

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

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

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

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

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

相关 javadoc生成API文档

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

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

相关包机制，生成javaDoc文档

包机制为了更好地组织类，Java提供了包机制，用于区别类名的命名空间包语句的语法格式位： package pkg1\[. pkg2\[. pkg3…\]\];

朴灿烈づ我的快乐病毒、/ 2022年10月30日 14:24/ 0 赞/ 222 阅读

相关 IDEA-生成Javadoc外部文档

IDEA-生成Javadoc外部文档 1. IDEA中，点击 Tools\-> Generate JavaDoc，这样会打开生成 javadoc 文档的配置页面。 2.

偏执的太偏执、/ 2022年10月30日 05:23/ 0 赞/ 212 阅读

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

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

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

相关 JavaDoc生成API

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

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

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

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

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

相关 IDEA生成JavaDOC文档

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

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