如何使用 scaladoc 包含对包的注释？答案

【问题标题】：How to include comments for a package with scaladoc?如何使用 scaladoc 包含对包的注释？
【发布时间】：2017-05-06 01:29:26
【问题描述】：

因此，对于 scaladoc，您可以为代码的特定组件指定 cmets，如下所示：

package connector

import java.io.RandomAccessFile;

/** Fs class guides file opening
  *
  */
object fs {
    def printFile(path:String):Unit = {
        val fl = new RandomAccessFile(path, "rw");
        println(fl.readLine());
        println(fl.getFilePointer());
        fl.close();
    }
}

但是，我看不出您将在何处或如何包含将出现在由 scaladoc 为包起始页生成的 index.html 中的注释。这是怎么做到的？

【问题讨论】：

标签： scala scaladoc

【解决方案1】：

创建一个包对象 (package.scala) 并在其中添加文档：

/**
 * Fs class guides file opening
 */
package object connector {}

【讨论】：