SCALEX概述

SCALEX 是一款开放源代码的 Scala 相关项目文档生成工具，支持 Scaladoc 以及 Javadoc，支持多种主题风格选择。它可以将源码中的注释自动生成文档，并可以与开发者的代码编辑器集成，进行代码分析，查看文档。

一、从 Scala 官网下载 SCALEX

SCALEX 的安装非常简单，只需要从 Scala 官网上下载相应的安装包即可，下面是下载地址和安装命令。

curl https://oss.sonatype.org/service/local/artifact/maven/content?r=releases&g=org.scala-sbt&a=scripted-sbt&v=LATEST -L -o sbt-launcher.jar
java -Xms512M -Xmx1536M -Xss1M -XX:+CMSClassUnloadingEnabled -jar sbt-launcher.jar

二、SCALEX与西门子系统

SCALEX 可以与西门子系统集成，通过在指定的编译目录中生成文档，方便西门子系统开发者使用。

val site = SbtSite.site taskKey[Unit]("Build the site.")
Settings.seq(scalaVersion := "2.12.6", SbtSite.settings: _*)

三、SCALEX与喜剧

SCALEX 也可以与喜剧集成，自动生成喜剧风格的文档，让文档看起来更加轻松有趣。

buildInfoPackage := "example.scaladoc",
buildInfoKeys += "version" -> version.value,
buildInfoKeys += "name" -> name.value,
buildInfoKeys += "buildTime" -> java.util.Calendar.getInstance.getTimeInMillis.toString,
buildInfoKeys += "commitSha" -> gitHeadSha.value

四、SCALEX虚拟机搭建

SCALEX 的搭建非常简单，只需要按照下面的命令即可开始文档生成。

docker run -it --rm -v $PWD:/data/ hseeberger/scala-sbt:11.0.6_1.3.10_2.13.1 bash
cd /data/
sbt doc

五、SCALEX旋钮的功能发音

SCALEX 还拥有旋钮功能，可以按照按键的顺序以及旋钮的方向进行提示发音。

import scala.language.dynamics
class Speak extends Dynamic {
  def applyDynamicNamed(methodName: String)(args: (String, Any)*) = ???//Speak方法实现内容
}

六、SCALEX与西门子PLC 1200

SCALEX 与西门子 PLC 1200 选型搭配使用，给 PLC 1200 开发者提供一个良好的编程文档生成系统。

libraryDependencies += "org.scalaz" %% "scalaz-core" % "7.2.16",
libraryDependencies += "org.scalaz" %% "scalaz-concurrent" % "7.2.16",
libraryDependencies += "org.typelevel" %% "cats-core" % "2.0.0",
libraryDependencies += "org.typelevel" %% "cats-effect" % "2.0.0"

七、SCALEX相关图片

SCALEX 也支持在文档中插入图片，方便开发者描述功能或者项目内容。

import $ivy.`com.lihaoyi::bs4-scalatags:0.6.2`, scalatags.Text.all._
val imgSrc = "https://www.scala-lang.org/resources/img/frontpage/scala-spiral.png"
figure(
  img(src:=imgSrc, width:=300),
  figcaption("This is a Scala logo")
)

八、总结

SCALEX 是一个非常强大的 Scala 文档生成工具，支持多种主题风格，可以与多种不同的技术产品集成使用。在使用 SCALEX 的过程中，需要注意数据的类型转换以及数据传递问题。