项目生成scaladoc和javadoc方式

最新推荐文章于 2022-07-01 09:47:16 发布

crystal__behappy

最新推荐文章于 2022-07-01 09:47:16 发布

阅读量1.8k

点赞数 1

分类专栏：大数据

本文链接：https://blog.youkuaiyun.com/u014407826/article/details/79699070

版权

大数据专栏收录该内容

5 篇文章

订阅专栏

一、生成scaladoc方式

目前网上关于scala类自动生成scaladoc的方式特别少，笔者在项目中也遇到这个问题，解决方式如下：

（1）在需要导出项目的pom.xml文件中添加：

<plugin>

                            <groupId>net.alchim31.maven</groupId>

                            <artifactId>scala-maven-plugin</artifactId>

                            <version>3.3.2</version>

</plugin>

（2）右键需要导出的模块，Run As---》RunConfigurations，选择MavenBuild---》process doc，修改Base directory和Goals。

（3）输入完成之后点击Run，会下载一些jar包，这里需要一段时间。

（4）控制台输出BUILD SUCCESS表示生成Scaladoc成功。

（5）去项目所在的文件夹，找到target文件夹，会多生成site文件夹，进入site文件夹就能看到生成的scaladoc：

二、生成javadoc方式

1. 从http://www.filigris.com/downloads/files/docflex-doclet-1.6.1.zip下载Doclet压缩包。

2. 将压缩包解压至任意目录（最好不包含中文、空格等特殊符号）。比如解压到D盘：

3. 在Eclipse中选择需要导出的包。

4. 点击鼠标右键，在右键菜单中选择Export选项。在弹出的对话框中选择JavaDoc选项，点击Next按钮。

5. 设置visibility选项为private，在文档中包含所有成员的描述。配置custom doclet选项，Doclet name如图示填写，Doclet class path填写为步骤2中Doclet解压目录中的docflex-doclet.jar文件所在路径。

其中：Doclet name：com.docflex.javadoc.Doclet

6. 如图示配置VM options和Extra Javadoc options。

(1) VM options中输入：

-encoding UTF-8 -charset UTF-8

说明：配置输出文件编码。

(2) Extra Javadoc options输入：

-template D:\docflex-doclet-1.6.1\templates\javadoc\PlainDoc.tpl

-p:windowTitle""

-p:docTtile""

-format RTF

-nodialog

-launchviewer=false

-d f:\doc

解释：-template参数指定定义JavaDoc文档格式的模板文件所在位置，

-d参数指定JavaDoc文档文件的输出位置。

注意：文件路径均需修改为本机对应路径。

7. 点击Finish按钮，即可在-d参数指定目录生成RTF格式的JavaDoc文档文件。

8. 可以看到eclipse控制台输出信息，没有报警告和错误表示生成成功。

9. 将生成的rtf文档另存为word格式。