2011-01-04 5 views
26

Hat /* (non-javadoc) eine Bedeutung, die den Leser des Quellcodes darüber hinaus darauf hinweist, dass ein Kommentarblock absichtlich kein Javadoc-Kommentar ist? In letzter Zeit habe ich eine Menge Code zu sehen, die wie folgt aussieht:Hat "/ * (non-javadoc)" eine gut verstandene Bedeutung?

/* 
* (non-javadoc) 
* 
* This method converts widgets to gizmos 
*/ 
public Foo bar() { 
    ... 

Ist dies eine etablierte Konvention irgendeine Art? Wenn ja, was bedeutet es (über die offensichtliche wörtliche Bedeutung hinaus) und wann wird es verwendet?

Antwort

18

Nach der info I could find, das war ein Bug in älteren Versionen des JavaDoc-Tool (oder wahrscheinlich ältere Version von Eclipse Verarbeitung von JavaDoc-Kommentaren) zu beheben, die nicht die richtige Dokumentation für eine Methode angezeigt, die die Methode überschreibt eine Elternklasse.

Wie von Konstantin erwähnt, enthält die Überschreibungsvorlage von Eclipse diesen Text.

+1

FYI: http://dev.eclipse.org/newslists/news.eclipse.platform/msg34412.html ist jetzt ein toter Link. –

+3

@MaxNanasy Offenbar hat Eclipse die Forum-Systeme vor einiger Zeit geändert und sie haben einzelne Posts nicht umgeleitet. Neuer Standort ist https://www.eclipse.org/forums/index.php/m/278495/ – Powerlord

15

Es hat keine etablierte Bedeutung neben einem Kommentar. Die Formatierung ist das Ergebnis üblicher Eclipse-Codeformatierungsvorlagen, was ihre Gemeinsamkeiten erklärt.

Verwandte Themen