Java Basics: 4 typische Verlinkungen mit {@link …} in Javadoc
Bei coodoo gehört neben sprechenden Klassen, Methoden und Attributen auch Javadoc immer noch zum guten Stil. Neben Textbeschreibungen sind in Javadoc auch Verlinkungen sehr hilfreich und praktisch. Typischerweise möchte man entweder auf ein Attribut, eine Methode oder eine andere Klasse verweisen.
Die notwendige Javadoc Annotation lautet {@link …} und das ist die Struktur:
Im folgenden Beispiel ist eine Klasse aus LigaHero zu sehen welche eine Bonusfrage beschreibt. Darin soll zum Einen direkt auf ein Attribut in der Klasse und zum Anderen auf eine andere Klasse referenziert werden.
Verlinkung auf ein Attribut in der eigenen Klasse
Soll auf ein Attribut in der eigenen Klasse verlinkt werden, reicht es aus das nur das Hashtag vor dem Attributnamen voranzustellen:
… ist {@link #customQuestion} <code>false</code>
Verlinkung auf eine Methode der eigenen Klasse
Soll auf eine Methode der eigenen Klasse verwiesen werden müssen einfach nur die Methodenklammern und alle Parameter als Typen mit angegeben werden:
… Mit der Methode {@link #setCustomQuestion(boolean)} kann
Verlinkung auf eine andere Klasse
Soll auf eine andere Klasse verwiesen werden dann einfach nur den Klassennamen angeben:
Abgabefrist in der {@link BonusfrageTipprundeConfig}.
Verlinkung mit einem Label anstatt dem Attributnamen
Soll auf eine andere Methode in der anderen Klasse verwiesen werden wird diese einfach mit # nach dem Klassennamen angegeben. Anstatt den kompletten Methodennamen kann man auch immer ein Label angeben:
… zu vergebenen {@link BonusfrageTipprundeConfig#getPoints() Punkte} oder
Generiertes Javadoc
Das Ergebnis sie z.B. in der Eclipse Javadoc Ansicht wie folgt aus:
