アノテーション

アノテーション

> リークスクリプト

現在、アノテーションは 7 種類あります。関数やメソッドの前に付けて、追加の情報を示すために使います。ローカル変数、グローバル変数、クラスにも適用できます。エディタでは、各アノテーションのドキュメントがマウスオーバーで表示されます。

アノテーションの使い方

アノテーションを使うには、次のように書きます。

または

アノテーションは重ねて付けることもできます。

既存のアノテーション

@deprecated

@deprecated を付けた関数やメソッドは、呼び出されるとコンパイル時に警告を表示します。これは、その関数がもう使われるべきではなく、後で削除される予定であることを示します。

例:

@todo

@todo を付けた関数やメソッドは、未完成であることを示すために、コンパイル時に todo タイプの警告を挿入します。

@unused

@unused を付けた関数やメソッドは、使われていなくても警告を出しません。これは特にストリクト・モードで、関数は実装済みだがコードから呼び出していない場合に便利です。

例:

補足:名前の先頭に _ を付ける(たとえば var _resultat)だけでも、アノテーションなしで「未使用」の警告を抑制できます。

@nodiscard

@nodiscard を付けた関数やメソッドは、戻り値が使われなかった場合に警告を表示します。

@pure

現在、@pure@nodiscard と同じ効果を持ちます。ただし @pure にはより多くの意味が込められています。

純粋な関数は状態を変更してはならず、副作用を持ってはいけません。つまり、自分のスコープ外の変数を変更してはならず、決定的でなければなりません(乱数を使わない)。

@override

@override を付けたメソッドは、親クラスのメソッドの実装を変更していることを開発者に示します。

例:

@tailrec

@tailrec を付けた関数やメソッドは、末尾再帰であることを示します。つまり、その関数は再帰的であり、再帰呼び出しが関数の最後の命令になっているということです。

このアノテーションはコンパイラにとって有用になりうるものですが、現在は一切使われていません。