プログラミング勉強日記

2020年11月23日
Javadocについて調べたときにアノテーションについて知ったので、まとめる。

アノテーションとは

　アノテーションは注釈、注記といった意味を表す英語で、プログラミング用語でも注意書きを追加する機能になり余白に文字を追加する機能。アノテーションを理解できればJavaのコードがより見やすくなる。
　アノテーションはデータの有無、データの数によって3種類に分かれる。

　記述するメソッドが親クラスのメソッドをオーバーライドしていることを示す。親クラスにないメソッドをエラーにして、記述の間違いをなくすことができる。

　記述するメソッドの仕様が非推奨であることを示す。Javaのバージョンが新しくなっても、前の記述を残してきたいときなどに使う。

　引数にメッセージを指定することで、記述するメソッドによる警告を非表示にすることができる。

　上で紹介した3つのアノテーションとは別に、独自のアノテーションを定義するために用意されているメタアノテーションと呼ばれているものがある。

独自に定義したアノテーションが何を対象としているか宣言するために使われる。クラスやメソッドに付けるのか、変数につけるのかを決める。

　コンパイル時やプログラム実行時にアノテーションの情報を保持するかどうかを決めるために使われる。

　作者の名前を記述する

　引数と引数の説明を記述

　戻り値の説明を記述

　メソッドが投げる例外クラスとその説明を記述

　クラスやメソッドなどのバージョンを記述

　他の関連するクラスやメソッドなどの参照先を記述