如何使用 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 {}

如何使用 scaladoc 包含对包的评论？

How to include comments for a package with scaladoc?

scala

scaladoc