Wie sagen Sie javadoc sagen, dass meine Periode einen Satz nicht beendet

Question

javadoc verwendet den ersten "Satz" eines Doc-Kommentars als einen zusammenfassenden Satz. Es wird davon ausgegangen, dass ein Punkt, gefolgt von einem Leerzeichen, Tabulator oder Zeilenabschluss, den Satz beendet. Angenommen, ich möchte eine Abkürzung wie "z. B." oder "usw." in meiner Zusammenfassung; Gibt es eine Möglichkeit, Javadoc zu sagen, es nicht als das Ende eines Satzes zu behandeln? Ich kann den Zeitraum durch . ersetzen, aber ich frage mich, ob es einen weniger hässlichen Weg gibt.

Answer 1

Es ist am besten, Punkte im ersten Satz zu vermeiden. In How to Write Doc Comments for the Javadoc Tool es empfohlen, dass Sie das Leerzeichen als Behelfslösung ersetzen sollte:

/** 
* This is a simulation of Prof. Knuth's MIX computer. 
*/ 

/** 
    * This is a simulation of Prof.<!-- --> Knuth's MIX computer. 
    */ 

Persönlich würde ich weglassen nur den Punkt, wenn ich nicht Abkürzungen ganz vermeiden konnte.