Javadoc'ta @ karakterinden nasıl kaçabilirsiniz?


180

@Javadoc'daki sembolden nasıl kaçabilirim ? Etiketleri içinde bir {@code}etiket içinde kullanmaya çalışıyorum <pre>.

Zaten html kaçış &#64;dizisini denedim , ama işe yaramadı.


@ {Code} bloğundaki girintilerin bir kısmını ayarladıktan sonra şimdi iyi görünmeye başladı! Bu önemliyse Eclipse'teydi.
JayL

Hala çalışamıyorum
Neil Benn

Yanıtlar:


267

{@literal}Javadoc etiketini kullanın :

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

Bunun için javadoc okuyacak:

This is an "at" symbol: @

Tabii ki, bu herhangi bir karakter için işe yarayacak ve herhangi bir "özel" karakteri görüntülemenin "resmi olarak desteklenen" yoludur.

Aynı zamanda en hızlı olanıdır - karakterin hex kodunu bilmenize gerek yoktur ve yazdıklarınızı okuyabilirsiniz!


1
Sembolden nasıl }kaçıyorsunuz?
ADTC

1
@ADTC Yapamazsınız. Neden istiyorsun? }HTML'de özel bir anlamı yoktur.
Bohemian

Bu yüzden sadece iki literaletikete bölebilirsiniz .
ADTC

23
Bunun kabul edildiğine ve çok iyi oy verildiğine şaşırdım. Sorunun öncüsü : {@code} etiketi içinde . {@literal} bir {@code} etiketi içinde çalışmaz.
Daniel

6
Bir etiketin içindeki işleri atlamak {ve kullanmak @literal @çalışır {@code}.
Brad Turek

55

HTML varlığı olarak yazmanız yeterlidir:

&#064;

" Javadoc - Java API Doküman Oluşturucu " belgesinden

@ Karakterine sahip bir satır başlatmak ve yorumlanmasını istemiyorsanız, @ HTML varlığını kullanın.

Bu, kaçmanız gereken herhangi bir karakter için HTML varlıklarını kullanabileceğiniz anlamına gelir ve gerçekten de şunları yapabilirsiniz:

Metin, HTML öğeleri ve HTML etiketleri ile HTML olarak yazılmalıdır. Tarayıcınızın desteklediği HTML sürümünü kullanabilirsiniz. Standart belge, basamaklı stil sayfaları ve çerçevelerinin eklenmesiyle başka bir yerde (belge yorumlarının dışında) HTML 3.2 uyumlu kod üretir. Çerçeve kümeleri nedeniyle oluşturulan dosyalar için HTML 4.0 tercih edilir.

Örneğin, sembol daha az (<) için kurum ve sembol büyüktür (>) olarak yazılmalıdır &lt;ve &gt;. Benzer şekilde ve işareti (&) olarak yazılmalıdır &amp;.


Bir boşluk tarafından takip edilmediğinde (örneğin ek açıklama
yazarken

8

benim çözümüm

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

Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.