Scala Language
スカラドック

Android apache-spark Haskell Language Java Language MongoDB MySQL postgresql Python Language Regular Expressions SQL
サーチ…


構文

  • メソッド、フィールド、クラスまたはパッケージの上に移動します。
  • /**始まる
  • 各行には、コメント付きで始まる*があります
  • 終わり*/

パラメーター

パラメータ詳細
クラス固有 _
@constructor detail クラスの主なコンストラクタを説明します。
メソッド固有 _
@return detail メソッドで返される内容の詳細。
メソッド、コンストラクタ、クラスタグ _
@param x detail メソッドまたはコンストラクタのvalueパラメータx詳細。
@tparam x detail メソッドまたはコンストラクタの型パラメータx詳細。
@throws detail 何が例外になるか。
使用法 _
@see detail 他の情報源を参照してください。
@note detail 事前条件または事後条件、または他の注目すべき制限または期待に関するメモを追加します。
@example detail サンプルコードまたは関連するサンプルドキュメントを提供します。
@usecase detail 完全なメソッド定義が複雑すぎる場合やノイズが多い場合に、単純化されたメソッド定義を提供します。
その他 _
@author detail 以下の著者に関する情報を提供します。
@version detail この部分が属するバージョンを提供します。
@deprecated detail 次のエンティティを非推奨とマークします。

シンプルなScaladocからメソッドへ

/**
  * Explain briefly what method does here
  * @param x Explain briefly what should be x and how this affects the method.
  * @param y Explain briefly what should be y and how this affects the method.
  * @return Explain what is returned from execution.
  */
def method(x: Int, y: String): Option[Double] = {
  // Method content
}


Modified text is an extract of the original Stack Overflow Documentation
ライセンスを受けた CC BY-SA 3.0
所属していない Stack Overflow