จะสร้างการเยื้องหลายระดับใน Javadoc ได้อย่างไร?


90

สมมติว่าเป็นส่วนหนึ่งของการบันทึกโค้ดของคุณ (Javadoc) คุณต้องการระบุว่าความสัมพันธ์ระหว่างองค์ประกอบที่ใช้การเยื้องลึก

ฉันจะสร้างรายการที่ซ้อนกันเป็น:

  • องค์ประกอบบางอย่าง
    • องค์ประกอบอื่น ๆ
      • แต่องค์ประกอบอื่น ๆ

คำตอบ:


135
<ul>
  <li>Element</li>
  <ul>
     <li>Subelement...</li>

คุณสามารถใช้ HTML ในความคิดเห็นของ javadoc ได้อย่างอิสระ

อัปเดต: เพราะมันเกิดขึ้นฉันจึงพยายาม

<ul>
    <li>one</li>
    <ul>
        <li>one point one</li>
    </ul>   
</ul>

และรับ

  • หนึ่ง
    • หนึ่งจุดหนึ่ง

ฉันเห็นด้วยว่าการทำรังที่เหมาะสมนั้นดีกว่า


2
ฉันจะบอกว่าที่ซ้อนกัน <ul> จะต้องอยู่ในองค์ประกอบ <li> บางส่วนเพื่อการเปรียบเทียบโปรดดูw3.org/wiki/HTML_lists#Nesting_lists
user2622016

คุณสามารถพูดได้ แต่การพยายามพูดบางอย่างที่แตกต่าง
Charlie Martin

1
@ ชาร์ลีแทนที่จะพูดว่า "ฉันเห็นด้วยกับการทำรังที่เหมาะสมดีกว่า" คุณอาจจะเขียนตัวอย่างที่แสดงวิธีการทำรังอย่างถูกต้อง? มิฉะนั้นผู้เริ่มต้นบางคนอาจไม่เข้าใจความคิดเห็นของคุณและใช้แบบฟอร์มดังกล่าวข้างต้น
Rauni Lillemets

2
ฉันเข้าใจว่า user2622016 หมายความว่าคุณต้องเขียนแบบนี้: <ul>< destroy <ul>... </li></ul></ul><ul><ul> <li> อยู่ด้านในสุด <ul> .. </p> > อยู่ในบล็อก <li> .. </li>
Rauni Lillemets

1
ถึงแม้ว่าผมจะไม่สามารถหาได้ระบุไว้อย่างชัดเจน (และฉันไม่ได้ดู) ก็สไตล์ที่ใช้ในเอกสารของออราเคิล นอกจากนี้ NetBeans ยังบ่นเกี่ยวกับเรื่องนี้ ในทางกลับกัน Intellij เพิ่ม</li>แท็กอย่างมีความสุข
SeverityOne

29

วิธีที่ถูกต้องมีดังนี้:

/**
 * <ul>
 *   <li>some element
 *   <li><ul>
 *     <li>some other element
 *     <li><ul>
 *       <li>yet some other element
 *     </ul>
 *   </ul>
 * </ul>
 */

แม้ว่า JavaDoc จะยืมมาจาก HTML แต่ก็ไม่ใช่ HTML และคุณควรละเว้น</li>แท็กเช่นเดียวกับที่คุณควรละเว้น</p>แท็ก


1
มีการอ้างอิงถึงการละเว้นแท็กปิดหรือไม่
friederbluemle

1
ใช่ที่นี่: oracle.com/technetwork/java/javase/documentation/… - แม้ว่าจะเป็นนัยยะมากกว่าที่จะเปิดเผย
SeverityOne

ไม่เข้าใจว่าทำไมคำตอบนี้จึงไม่มีการโหวตเพิ่มขึ้น
John Smith

8

<li>รายการซ้อนกันควรจะอยู่ในตัวของมันเอง <ul>ไม่ใช่องค์ประกอบลูกที่ถูกต้องของ<ul>.

ตัวอย่างของคุณจะเป็น:

<ul>
  <li>some element</li>
  <li>
    <ul>
      <li>some other element</li>
      <li>
        <ul>
          <li>yet some other element</li>
        </ul>
      </li>
    </ul>
  </li>
</ul>

รหัสของคุณส่งผลให้รายการว่างเปล่า แม้ว่าจะซ้อนกันอย่างถูกต้องใน HTML แต่ผลลัพธ์ที่แสดงก็น่าเกลียด
naXa
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.