Bagaimana saya bisa menggunakan "<" dan ">" di javadoc tanpa pemformatan?

121

Kalau saya tulis <xmlElement>dengan javadoc tidak muncul, karena tag mempunyai fungsi khusus pada format teks.

Bagaimana saya bisa menampilkan karakter ini di javadoc?

java javadoc

— Tom Brito
sumber

4

Terkait tetapi tidak cukup menipu: stackoverflow.com/questions/1782040/…

— Muncul

160

Anda dapat menggunakan <untuk < dan >untuk > .

— Pavitar Singh
sumber

atau Anda dapat menggunakan & amp; untuk melarikan diri dari &

— ILMTitan

14

@TomBrito Meskipun ini menjawab pertanyaan sebenarnya, saya percaya perlunya untuk menghindari tanda-tanda hanya muncul ketika mereka digunakan sebagai tanda kurung sudut (yaitu berpasangan), yang pada gilirannya menyiratkan bahwa mereka adalah bagian dari beberapa kode (seperti tag XML, seperti dalam kasus OP). Dalam situasi ini, saya yakin solusi yang lebih baik adalah membungkus seluruh potongan XML dalam {@code ...}tag, seperti yang disarankan oleh Etienne Delavennat dalam jawabannya.

— Zoltán

&gtatau &lttidak persis sama artinya dengan tanda kurung siku dalam format XML. Tapi {@code <>}itu pilihan yang tepat.

— cinqS

63

Versi terbaru JavaDoc mendukung {@literal A C}; ini mengeluarkan konten dengan benar (meng-escape '<' dan '>' dalam HTML yang dihasilkan).

Lihat http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html

— Kapal Howard M. Lewis
sumber

41

Mengingat XML adalah kode sebenarnya, saya yakin cuplikan XML di Javadoc lebih cocok untuk tag {@code A C} daripada tag {@literal A C}.

Tag {@code} menggunakan font dengan lebar tetap yang menjadikan kontennya menonjol sebagai kode sebenarnya.

— Etienne Delavennat
sumber

2

Saya setuju. XML harus dibungkus dengan {@code }tag. Ini akan ditampilkan lebih alami (dengan font lebar tetap), dan tidak akan terlihat aneh di javadoc sumber, karena Anda tidak harus keluar dari kurung sudut secara terpisah.

— Zoltán

15

Lepaskan mereka sebagai HTML: <dan>

— duffymo
sumber

9

Anda hanya perlu menggunakan HTML yang setara untuk salah satu tanda kurung sudut. The <dapat direpresentasikan sebagai baik <atau <. Berikut contoh yang diambil dari Javadoc asli:

<pre>
& lt; complexType>
  & lt; complexContent>
    & lt; restriksi base = "{http://www.w3.org/2001/XMLSchema}anyType">
      & lt; urutan>
      [...]

Ini ditampilkan sebagai:

<complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>

— Muncul
sumber

3

Jika Anda mengatur maven untuk menggunakan penurunan harga , Anda bisa mengelilinginya dengan backticks.

`AC` berbunyi sedikit lebih bagus dari {@code AC}

— Owen
sumber

2

Interposisi <pre> dan {@code} menyimpan tanda kurung siku dan baris kosong di javadocs dan digunakan secara luas, lihat java.util.Stream misalnya.

<pre>{@code
   A<B>C

   D<E>F
}</pre>

— Serg
sumber

1

Kelilingi saja dengan {@code}seperti ini:

{@code <xmlElement>}

— ivanjermakov.dll
sumber