ฉันจะใช้“ <” และ“>” ใน javadoc โดยไม่ต้องฟอร์แมตได้อย่างไร

หากฉันเขียน<xmlElement>ใน javadoc จะไม่ปรากฏขึ้นเนื่องจากแท็กมีฟังก์ชันพิเศษในการจัดรูปแบบข้อความ

ฉันจะแสดงตัวอักษรนี้ใน javadoc ได้อย่างไร?

คุณสามารถใช้<สำหรับ<และ>สำหรับ>

JavaDoc เวอร์ชันล่าสุดรองรับ {@literal A <B> C}; สิ่งนี้ส่งออกเนื้อหาอย่างถูกต้อง (หลีกเลี่ยง '<' และ '>' ใน HTML ที่สร้างขึ้น)

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

การพิจารณา XML เป็นโค้ดจริงฉันเชื่อว่าข้อมูลโค้ด XML ใน Javadoc เหมาะกับแท็ก {@code A <B> C} มากกว่าแท็ก {@literal A <B> C}

แท็ก {@code} ใช้แบบอักษรที่มีความกว้างคงที่ซึ่งทำให้เนื้อหามีความโดดเด่นเหมือนกับโค้ดจริง

หลีกเลี่ยงเป็น HTML: <และ>

คุณจะต้องใช้ HTML ที่เทียบเท่ากับวงเล็บมุมหนึ่งเท่านั้น <สามารถแสดงเป็นอย่างใดอย่างหนึ่งหรือ< <นี่คือตัวอย่างที่นำมาจาก Javadoc จริง:

<pre>
& lt; complexType>
  & lt; complexContent>
    & lt; restriction base = "{http://www.w3.org/2001/XMLSchema}anyType">
      & lt; ลำดับ>
      [ ... ]

สิ่งนี้จะแสดงเป็น:

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

หากคุณตั้งค่า maven ขึ้นเพื่อใช้ markdownคุณสามารถล้อมรอบด้วย backticks

`A<B>C` อ่านได้ดีกว่าเล็กน้อย {@code A<B>C}

การแทรกระหว่าง <pre> และ {@code} จะบันทึกวงเล็บมุมและเส้นว่างใน javadocs และใช้กันอย่างแพร่หลายดูตัวอย่างเช่น java.util.Stream

<pre>{@code
   A<B>C

   D<E>F
}</pre>

เพียงแค่ล้อมรอบด้วย{@code}สิ่งนี้:

{@code <xmlElement>}