Neue javadoc Annotation @apiNote

9

Ich habe ein neues und undokumentiertes Javadoc-Tag bei LongStream Klassendokumentation. Der javadoc-Tag @apiNote scheint verwendet zu werden, um einige Erklärungen zu einer Methode zu geben, aber es gibt keine Dokumentation oder Versionshinweise zu diesem Tag.

Was ist der wahre Zweck davon? Wo ist die Dokumentation?

Ein kompiliertes Javadoc-Beispiel mit @apiNote finden Sie unter Reduzieren Sie die Methodendokumentation

    
Rafael Borja 26.03.2014, 21:26
quelle

1 Antwort

6

Aus der von @ bargenson zitierten Mailingliste:

  

Diese Tags werden mit der Funktion "-tag" in der Befehlszeile des javadoc-Tools aktiviert. Sie werden nicht als Standard-Javadoc-Tags vorgeschlagen und können in zukünftigen Java-Versionen anders implementiert werden. Da sie als benutzerdefinierte Tags nur für die JDK-API-Dokumentation implementiert sind, können Sie sie nicht automatisch in Ihrem eigenen Code verwenden. (Sie können natürlich Ihre javadoc-Aufrufe denselben Befehlszeilenoptionen hinzufügen, wenn Ihnen diese Tags gefallen).

Sie sind also keine Standard-Javadoc-Tags.

    
EJP 27.03.2014, 01:45
quelle

Tags und Links