如何包含带有scaladoc的包的注释？

Question

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

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中的注释。这是怎么做的？

Answer 1

创建一个包对象(package.scala)，并在那里添加文档：

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