Scala中的变量文档

Question

我是Scala的新手（我来自Java），我想知道如何为类变量生成文档的正确方法。

例如，如果我有以下代码：

class MyClass (bar:bar) {

  val foo = bar

  def function {
      ...
      ...
  }
}

为变量foo创建文档的正确方法是什么？我只是在声明之前添加评论吗？是不是有点混乱？

谢谢！

Answer 1

您可以在Scala中使用Javadoc。但Scala还引入了自己的文档生成器Scaladoc。这是用于生成标准语言documentation。

的内容

通常，Scaladoc遵循与Javadoc类似的约定，但引入了新功能。您可以阅读有关Scaladoc评论样式here的更多信息。

Answer 2

java和scala注释之间没有区别。您可以选择在java中使用的任何文档策略。