Wie sag javadoc, dass meine Periode einen Satz nicht beendet

8

javadoc verwendet den ersten "Satz" eines Dok-Kommentars als Zusammenfassung. 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.

    
ajb 16.08.2013, 21:01
quelle

1 Antwort

4

Es ist am besten, Punkte im ersten Satz zu vermeiden. In Schreiben von Doc-Kommentaren für das Javadoc-Tool wird vorgeschlagen, dass Sie es ersetzen sollten das Leerzeichen als Workaround:

%Vor%

Ich persönlich würde den Punkt einfach weglassen, wenn ich Abkürzungen überhaupt nicht vermeiden könnte.

    
Kapep 16.08.2013, 21:26
quelle

Tags und Links