Làm cách nào để sử dụng “<” và “>” trong javadoc mà không cần định dạng?

121

Nếu tôi viết <xmlElement>bằng javadoc, nó không xuất hiện, vì các thẻ có chức năng đặc biệt về định dạng văn bản.

Làm cách nào để hiển thị các ký tự này trong javadoc?

java javadoc

— Tom Brito
nguồn

4

Có liên quan nhưng không hoàn toàn là dupe: stackoverflow.com/questions/1782040/…

— Pops

160

Bạn có thể sử dụng <cho < và >cho > .

— Pavitar Singh
nguồn

hoặc bạn có thể sử dụng & amp; để thoát khỏi &

— ILMTitan

14

@TomBrito Mặc dù điều này trả lời cho câu hỏi thực tế, tôi tin rằng sự cần thiết phải thoát khỏi các dấu hiệu chỉ xuất hiện khi chúng được sử dụng làm dấu ngoặc nhọn (tức là theo cặp), do đó ngụ ý rằng chúng là một phần của một số mã (chẳng hạn như thẻ XML, như trong trường hợp của OP). Trong tình huống này, tôi tin rằng giải pháp tốt hơn là gói toàn bộ đoạn mã XML trong {@code ...}các thẻ, như Etienne Delavennat đã đề xuất trong câu trả lời của mình.

— Zoltán

&gthoặc &ltkhông cùng nghĩa với dấu ngoặc nhọn ở định dạng XML. Nhưng {@code <>}là một sự lựa chọn đúng đắn.

— cinqS

63

Các phiên bản JavaDoc gần đây hỗ trợ {@literal A C}; điều này xuất ra nội dung chính xác (thoát '<' và '>' trong HTML được tạo).

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

— Tàu Howard M. Lewis
nguồn

41

Xem xét XML là mã thực, tôi tin rằng các đoạn mã XML trong Javadoc phù hợp hơn với thẻ {@code A C} hơn là thẻ {@literal A C}.

Thẻ {@code} sử dụng phông chữ có chiều rộng cố định giúp nội dung của thẻ nổi bật như mã thực.

— Etienne Delavennat
nguồn

2

Tôi đồng ý. XML phải được bao bọc trong {@code }các thẻ. Nó sẽ được hiển thị tự nhiên hơn (với phông chữ có chiều rộng cố định) và nó sẽ không trông kỳ lạ trong javadoc nguồn, bởi vì bạn không phải thoát khỏi các dấu ngoặc nhọn riêng.

— Zoltán

15

Thoát chúng dưới dạng HTML: <và>

— duffymo
nguồn

9

Bạn chỉ cần sử dụng HTML tương đương cho một trong các dấu ngoặc nhọn. Có <thể được biểu diễn dưới dạng <hoặc hoặc <. Đây là một mẫu được lấy từ Javadoc thực:

<pre>
& lt; complexType>
  & lt; complexContent>
    & lt; restriction base = "{http://www.w3.org/2001/XMLSchema}anyType">
      & lt; trình tự>
      [...]

Điều này hiển thị là:

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

— Pops
nguồn

3

Nếu bạn thiết lập maven để sử dụng markdown , bạn có thể chỉ cần bao quanh nó bằng các dấu gạch chéo.

`AC` đọc đẹp hơn một chút {@code AC}

— Owen
nguồn

2

Sự xen kẽ của <pre> và {@code} lưu dấu ngoặc nhọn và dòng trống trong javadocs và được sử dụng rộng rãi, xem java.util.Stream chẳng hạn.

<pre>{@code
   A<B>C

   D<E>F
}</pre>

— Serg
nguồn

1

Chỉ cần bao quanh nó với {@code}như thế này:

{@code <xmlElement>}

— ivanjermakov
nguồn