Attributorientierte Programmierung

Annotationen sind ein Mittel zur Strukturierung von Programmquelltexten, bei der die Erzeugung von Programmtexten und mit der Programmierung verbundener Hilfsdateien teilweise automatisiert wird. Als Informationsgrundlage für die automatische Erzeugung der zusätzlichen Dateien werden Informationen aus dem Quelltext herangezogen, die vom Compiler bei der Übersetzung ausgeklammert werden. Diese Informationen nennt man Metainformationen, Metadaten, Anmerkungen, Annotationen oder Attribute.

Programmiersprachen, die diese Form der Einbindung von Metainformationen ermöglichen, sind unter anderem Java und C#. Mit Hilfe von Zusatzwerkzeugen lassen sich Metainformationen auch in Sprachen einbetten, wenn deren Syntax diese nicht explizit unterstützt. Die Metadaten werden dann üblicherweise in Kommentaren vor dem Compiler verborgen und mit den Zusatzwerkzeugen ausgewertet.

Annotationen in Java

Die Programmiersprache Java stellt mit Javadoc und den Annotationen zwei Mechanismen zum Einbinden von Metadaten zur Verfügung. Diese werden insbesondere im J2EE-Umfeld eingesetzt, um verschiedene Dateien automatisiert zu erzeugen. Dazu zählen beispielsweise SQL-Dateien, Deployment-Deskriptoren und die mit Enterprise Java Beans verbundenen Schnittstellen (Remote Interface, Home Interface, ...).

Javadoc

Hauptartikel: Javadoc

Javadoc ist ein Werkzeug zur Auswertung von Kommentaren im Quelltext, das mit Java 1.2 eingeführt wurde. Dazu werden Kommentare, die ausgewertet werden sollen mit der Zeichenkette /** eingeleitet. Innerhalb dieser Kommentare können dann spezielle Tags verwendet und diesen jeweils eine Zeichenkette als Wert zugewiesen werden.

Die Auswertung erfolgt mittels des gleichnamigen Werkzeugs Javadoc, das ursprünglich zur automatisierten Quelltext-Dokumentation entworfen wurde. Eine weitere Möglichkeit stellt das insbesondere im J2EE-Umfeld eingesetzte XDoclet dar. Das folgende Beispiel zeigt, wie man die Softwareversion mittels Javadoc angibt:

/**
 * @version 1.5
 */
public class A {}

Annotationen (ab Java 5)

Hauptartikel: Annotation (Java)

Mit der Sprachversion Java 5 wurden Annotationen als ein eigenes Sprachelement geschaffen. Annotationen werden im Quelltext durch ein @-Zeichen gefolgt vom Namen der Annotation gekennzeichnet. Zusätzlich ist es auch möglich, Annotationen Parameter zu übergeben. Außerdem können den vorgegebenen Annotationen auch eigene hinzugefügt werden.

Annotationen können mittels des Annotation Processing Toolkits (APT) direkt im Quelltext oder mittels Reflexion zur Laufzeit eines Programms ausgewertet werden. Unter anderem dadurch entstehen weitere Einsatzmöglichkeiten im Vergleich zu Javadoc. So wertet beispielsweise der Compiler selbst einige Annotationen aus. Das folgende Beispiel zeigt, wie man eine Compiler-Warnung mittels der entsprechenden Annotation unterdrückt:

public class A {
  @SuppressWarnings("unchecked")
  public void meineMethode() {}
}