2010-02-18 7 views
148

Wie kann ich das @ Symbol in Javadoc entkommen? Ich versuche, es in einem {@code} Tag zu verwenden, das innerhalb <pre> Tags ist.Wie können Sie dem @ -Zeichen in Javadoc entkommen?

Ich habe bereits versucht, die HTML-Escape-Sequenz &#64;, aber das hat nicht funktioniert.

+0

Jetzt ist es die Anzeige gestartet fein, nachdem ich einige der Vertiefung innerhalb des @ {Code} Block eingestellt! Dies war in Eclipse, wenn es darauf ankommt. – JayL

+0

Ich kann es immer noch nicht funktionieren –

Antwort

211

Verwenden Sie das {@literal} javadoc tag:

/** 
* This is an "at" symbol: {@literal @} 
*/ 

Die javadoc hierfür wird gelesen:

This is an "at" symbol: @ 

Natürlich wird diese für Arbeit jede Zeichen und ist die „offiziell unterstützte "Art und Weise, irgendwelche" speziellen "Zeichen anzuzeigen.

Es ist auch die geradeste - Sie müssen nicht wissen, den Hex-Code des Zeichens, und können Sie lesen, was Sie eingegeben haben!

+1

Wie entgeht man dem '}' Symbol? – ADTC

+1

@ADTC Sie können nicht. Warum willst du? '}' hat in html keine besondere Bedeutung. – Bohemian

+0

Also ich denke, Sie können es nur in zwei "literal" -Tags teilen. – ADTC

1

Sie die allgemeine Idee bekam, versuchen Sie die Oktaldarstellung mit: &#064;

+5

Dies ist nicht oktal. – Joey

+0

'' '' 'hat den Codepunkt 0x40 in hexadezimal, was 64 in Dezimal ist –

41

Schreiben Sie einfach als HTML-Einheit:

&#064; 

Aus dem Dokument "javadoc - The Java API Documentation Generator"

Wenn Sie Möchten Sie eine Zeile mit dem Zeichen @ beginnen und nicht interpretiert werden, verwenden Sie die HTML-Entität @.

Dies bedeutet, dass Sie HTML-Entitäten für jede Zeichen, das Sie entkommen müssten, und in der Tat können Sie folgende Möglichkeiten:

Der Text muss mit HTML-Entitäten und HTML-Tags in HTML geschrieben werden . Sie können die von Ihrem Browser unterstützte HTML-Version verwenden. Das Standard-Doclet generiert HTML 3.2-konformen Code an anderer Stelle (außerhalb der Dokumentationskommentare) unter Einbeziehung von Cascading Stylesheets und Frames. HTML 4.0 wird aufgrund der Framesets für generierte Dateien bevorzugt.

Zum Beispiel Einheiten für die weniger als Symbol (<) und die größer ist als Symbol (>) als &lt; und &gt; geschrieben werden. Entsprechend sollte das kaufmännische Und (&) als &amp; geschrieben werden.

+0

dies funktioniert gut mit java6, aber nicht mit java5 –

+1

Dies zeigt sich buchstäblich in Eclipse. –

+5

Dies scheint in JDK1 nicht zu funktionieren.8 –

5

meine Lösung ist

/** 
* Mapper Test Helper. 
* 
* add the following annotations above the class 
* <pre>{@code 
* // junit5 
* @literal @ExtendWith(SpringExtension.class) 
* // junit4 
* @literal @RunWith(SpringRunner.class) 
* }</pre> 
*/ 
+1

Nur etwas, das in '{@ code' mit Java 8 funktioniert. – Alex

Verwandte Themen