Ich habe eine Java-Klasse, für die ein Teil des Javadocs tatsächlich als Teil des Build-Prozesses generiert wird: Der Rückgabewert einer Methode (ein statischer String-Wert) wird in die Quelldatei eingefügt, ähnlich wie $Revision: $ -Tags funktionieren in einigen Versionskontrollsoftware.
Dieses Verhalten mag zwar fragwürdig sein, aber diese Duplizierung von Informationen wird von dem von mir verwendeten Framework (WEKA Machine Learning Library) gefordert. Ich möchte, dass der Codeformatierer von Eclipse die generierten Kommentare nicht beeinflusst. Ich benutze die Eclipse Indigo Version.
Ich kann den Formatierer mit den speziellen Kommentaren //@formatter:on und //@formatter:off ein- / ausschalten. Die @formatter -Tags funktionieren jedoch nur in 'normalen' Kommentaren, nicht in Javadoc-Kommentaren. Offensichtlich könnten sie leicht für Javadoc-Tags verwechselt werden. Das bedeutet, dass ich den Formatierer (z. B. automatischen Zeilenumbruch) für den generierten Teil des Javadoc-Kommentars nicht deaktivieren und für den Rest anlassen kann, weil die @formatter -Direktiven um den Javadoc-Kommentar platziert werden müssen.
Gibt es einen Workaround, um Code-Formatierung innerhalb von Javadoc-Kommentaren umzuschalten?
Es ist schon eine Weile her, dass dies gefragt / beantwortet wurde und mir geholfen hat, die folgende Antwort zu verfeinern, hoffentlich zusätzlich nützlich. Ich benutze diese Alternative, weil ich JavaScript in Javadocs ausführen wollte.
Eclipse bietet die @formatter: off und @formatter: auf denen über Windows aktiviert werden muss- & gt; Einstellungen- & gt; java- & gt; code style- & gt; formatter ::: bearbeiten button ::: tab "off / auf Tags ". Sie können in Kommentaren verwendet werden.
Rund um das Doc-Zeug
%Vor% Aber wenn Sie möchten, dass der Formatierer im Javadoc ausgeschaltet wird, verwenden Sie den
@formatter: xxx innerhalb von HTML-Kommentaren <!-- xxxxx --> , um anzuzeigen, was Sie tun
versuchen zu tun. Verwenden Sie <code>...</code> bloack, um sicherzustellen, dass keine Formatierung erfolgt und
die Aufnahme von Code als Javascript.
Editierte die Code-Anweisungen in dem Beispiel, wie ich das bei Eclipse arbeiten wollte und Netbeans. Ich fand den Formatierer: von der Arbeit, aber dann hörte ich auf, an einem anderen zu arbeiten Version von Eclipse (ja, ich verwende mehrere IDE-Versionen).
%Vor%Tags und Links eclipse weka javadoc code-generation eclipse-jdt