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。