Javadoc-Tag für Leistungsüberlegungen

Question

Gibt es ein javadoc-Tag für Leistungsüberlegungen?

Man könnte sich vorstellen:

/** 
* ...other javadoc tags... 
* @perform Expected to run in O(n) time if image exists with O(k) memory usage 
*/ 
public Image getImage(URL url, String name) { 
    //code goes here 

Wenn es nicht gebaut wird, gibt es einige de facto benutzerdefinierte Tag, die Menschen benutzen?

Answer 1

Es gibt keinen Standard, wirklich. Wenn Sie dies tun, pflegen Sie einfach ein Format, das Sie (oder Ihre Organisation) bevorzugen und konsistent halten.

Answer 2

Ab Java 8 wurde ein neues Tag für diese Art von Betrachtung hinzugefügt, das @implNote heißt.

Wie beschrieben here es kann wie folgt verwendet werden:

/** 
* Picks the winners from the specified set of players. 
* <p> 
* The returned list defines the order of the winners, where the first 
* prize goes to the player at position 0. The list will not be null but 
* can be empty. 
* @implNote This implementation has linear runtime and does not filter out 
*   null players. 
* @param players 
*   the players from which the winners will be selected 
* @return the (ordered) list of the players who won; the list will not 
*   contain duplicates 
* @since 1.1 
*/ 
default List<String> pickWinners(Set<String> players) { 
    return new ArrayList<>(players); 
} 

Darüber hinaus gibt es zwei weitere Tags hinzugefügt, die in this Frage diskutiert werden.

Es ist erwähnenswert, dass es einige Details darüber gibt, die nicht Teil der Javadoc-Spezifikation sind und stattdessen etwas sind, das von Orakel und umfassend im JDK verwendet wird. Aus diesem Grund, die gleiche Quelle wie oben Details, die Sie die folgenden Befehlszeilenoptionen verwenden müssen, damit sie:

-tag "apiNote:a:API Note:" 
-tag "implSpec:a:Implementation Requirements:" 
-tag "implNote:a:Implementation Note:" 

Sie haben unterschiedliche Höhe der Unterstützung durch IDEs (zB können Sie nicht die oben genannten Befehlszeilenargumente gesetzt in Eclipse), was sie weniger nützlich macht, als sie sein könnten.