ソースコード内の Java の注釈

関連項目

Java プラットフォームが JDK 1.5 またはそれ以上に設定されている場合は、ソースエディタでの作業中にソースコード内で Java 注釈を使用できます。 Java 注釈は、パッケージ、メソッド、およびフィールドなどのコードの中で、項目を("注釈")とマークするために、ソースコードの中で使用できます。 リソース依存、属性、および配備など、注釈付きコードに関する追加メタデータを提供するために、注釈を使用できます。

ソースコードの注釈には、接頭辞として @ シンボルが付いているので、簡単に識別できます。 次は、Override 注釈型で表示されたメソッドの例です。

@Override
public String getDiscountCode() {
    return this.discountCode;
}

IDE を使用してテンプレートまたはソースコードを生成する場合、IDE が生成したコードに注釈が含まれることがあります。 たとえば、IDE を使用してエンティティークラスを生成した場合、IDE は次のようなコードを生成します。

@Entity
public class NewEntity implements Serializable {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;
}    

エンティティークラスを明示するために、コード内で @Entity 注釈が使用されています。 id フィールドを明示するために、@Id 注釈および @GeneratedValue 注釈が使用されています。 エンティティークラスでは、データベース行にフィールドをマップするために、配備記述子の代わりに注釈が使用されることもしばしばあります。

注釈の生成にコード補完またはテンプレートを使用する場合、IDE は注釈をサポートするのに必要なインポート文を自動的に追加します。

コード補完を使用して注釈を生成する

ソースコードでの注釈の使用を支援するのに、IDE のコード補完機能を使用できます。 コード補完によって、注釈の使用法を提案したり、コード内に注釈を生成したりできます。 @ と入力してから Ctrl-Space キーを押すと、コード補完ダイアログボックスが表示され、使用可能な注釈の型が表示されます。 必要な注釈メンバーの指定を支援するために、コード補完を使用することもできます。

関連項目
コード補完機能の使用方法
Web サービスの注釈について
注釈を介した Web サービスの構成
エンティティークラスのマッピング
プロジェクト内へのターゲット JDK の設定

著作権と商標について