Scala:Scaladoc的生成方法

4 篇文章 0 订阅
2 篇文章 0 订阅
本文档介绍了如何在修改Spark源码并添加注释后,使用Maven命令在Git Bash中生成Scaladoc。通过修改pom.xml文件,可以选择生成site或doc。成功执行后,可在指定文件夹中找到包含API文档的index.html。
摘要由CSDN通过智能技术生成

项目场景:

根据需求对spark源码进行修改后,并完成相应注释。
使用maven命令在git bash中对修改后的项目进行文档doc生成,即有api文档等的index.html


准备描述:

两种方式:生成site、生成doc
提示:第一步:修改pom.xml文件

site and doc都要改:

<plugin>
    <groupId>org.scala-tools</groupId>
    <artifactId>maven-scala-plugin</artifactId>
  </plugin>

site要改:

<properties>
    ...
    <dependency.locations.enabled>false</dependency.locations.enabled>
</properties>

具体代码:

# generate a site
mvn site
# generate only the doc
mvn scala:doc

结果:

在这里插入图片描述
在 文件夹

target/site/scaladocs/

里可以找到index.html

在这里插入图片描述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值