Scala中的变量文档

Question

我是Scala中的新成员（我来自Java），我想知道如何为类变量生成文档。

举例来说，如果我有以下代码：

class MyClass (bar:bar) { 

    val foo = bar 

    def function { 
     ... 
     ... 
    } 
} 

什么是创建变量foo文件的正确方法是什么？我是否在宣言前添加评论？这是不是有点混乱？

谢谢！

Answer 1

java和scala评论没有区别。你可以选择你在java中使用的任何文档策略。

Answer 2

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

一般来说，Scaladoc遵循Javadoc的类似惯例，但引入了新功能。你可以阅读更多关于Scaladoc评论风格here。