Java: Erstellen neuer Anmerkungen

Sie haben Kommentare in vielen Java-Codebeispiele verwendet gesehen. Der Compiler ignoriert Kommentare, so dass, wenn Sie einen Kommentar erstellen können Sie alles schreiben, die Sie hilfreich sein, das Gefühl wird später herauszufinden, was die Anwendung tun kann. Kommentare dokumentieren Ihren Code.

Allerdings gibt es eine andere Art von Dokumentation - die Anmerkung. Eine Anmerkung ist eine Art von Dokumentation, die der Compiler auch versteht. Wenn der Compiler Anmerkung in Ihrem Code sieht, weiß er, dass es etwas Besonderes mit dem Code tun muss, die folgt. Anmerkungen sind hilfreich in Ihrem Code in einer funktionalen Weise zu dokumentieren, so dass der Compiler kann Ihnen helfen, erzwingen, was Dokumentation, die Sie zur Verfügung stellen.

Der Satz von vordefinierten Anmerkungen, die mit Java kommen, sind relativ im Einsatz begrenzt. So erstellen Sie wirklich nützliche Anmerkungen, müssen Sie sie selbst entwerfen oder sie als Teil eines Drittanbieters Paket. eine neue Anmerkung zu schaffen, ist ein Prozess in drei Schritten:

1. Fügen Sie die entsprechende Import-Anweisung:

   importieren java.lang.annotation *. -

2. Definieren Sie eine Schnittstelle, die die Anmerkung an den Compiler beschreibt:

   . // Eine Anmerkung Beschreibung @ Dokumentierte @ Schnittstelle AuthorData {String Name () - String Date () - Doppel-Version () Standard 1,0-}

   In diesem Fall erscheint die Anmerkung in der Dokumentation von Javadoc erstellt, weil es die @Documented Annotation enthält. Jede Anmerkung Beschreibung beginnt mit dem @interface Schlüsselwort durch den Namen des Annotationstyp gefolgt, die AuthorData in diesem Fall ist.

   Innerhalb der geschweiften Klammern finden Sie die Felder verwendet, um die Kommentardaten definieren. Dieses Beispiel enthält Name, Datum und Version. Der Standard Schlüsselwort liefert einen Wert für ein bestimmtes Feld. Das heißt, der Bereich wird um den Wert verwenden, wenn es nicht als Teil der Anmerkung in der Anwendung definiert wird.

3. Verwenden Sie die Anmerkung in der Anwendung:

   @AuthorData (Name = "John Smythe" Date = "2014.04.01")

   Die Anmerkung erscheint vor dem Element es wirkt, wie eine Klassendeklaration. Sie müssen jedes Feld definieren, die keinen Standardwert hat. Optional definieren Sie auch Felder, die einen Standardwert verfügen. In diesem Fall ist der Name des Autors John Smythe, und der Code wurde zuletzt am 2014.04.01 aktualisiert.