Bagaimana cara membuat beberapa tingkat lekukan di Javadoc?

89

Misalkan, sebagai bagian dari pendokumentasian kode Anda (Javadoc), Anda ingin menunjukkan bahwa hubungan antar elemen menggunakan indentasi dalam.

Bagaimana cara membuat daftar bersarang sebagai:

  • beberapa elemen
    • beberapa elemen lainnya
      • namun beberapa elemen lainnya
documentation javadoc indentation nested-lists James Raitsev
sumber

Jawaban:

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

Anda dapat dengan bebas menggunakan HTML di dalam komentar javadoc.

Pembaruan: Karena itu muncul, saya mencoba

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

dan dapatkan

  • satu
    • satu koma satu

Saya setuju bersarang yang tepat lebih baik.

Charlie Martin
sumber
2
Saya akan mengatakan <ul> bersarang harus berada di dalam beberapa elemen <li>, untuk perbandingan lihat w3.org/wiki/HTML_lists#Nesting_lists
user2622016
Anda bisa mengatakan itu, tetapi mencobanya akan mengatakan sesuatu yang berbeda.
Charlie Martin
1
@Charlie Daripada mengatakan "Saya setuju membuat sarang yang tepat lebih baik.", Mungkin Anda dapat menulis contoh yang menunjukkan cara membuat sarang yang benar? Jika tidak, mungkin beberapa pemula tidak akan memahami komentar Anda dan menggunakan formulir yang disebutkan di atas.
Rauni Lillemets
2
Saya mengerti bahwa user2622016 berarti Anda harus menulis seperti ini: <ul><li><ul>...</ul></li> </ul>, sehingga <ul> .. </ ul yang paling dalam > juga di dalam blok <li> .. </li>.
Rauni Lillemets
1
Meskipun saya tidak dapat menemukannya secara eksplisit (dan saya memang melihatnya), itu adalah gaya yang digunakan dalam dokumentasi Oracle . Juga, NetBeans mengeluhkannya. Intellij, di sisi lain, dengan senang hati menambahkan </li>tag
SeverityOne
29

Cara yang benar adalah sebagai berikut:

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

Meskipun JavaDoc meminjam dari HTML, ini bukan HTML, dan Anda harus menghilangkan </li>tag, sama seperti Anda harus menghilangkan </p>tag.

SeverityOne
sumber
1
Adakah referensi untuk menghilangkan tag penutup?
friederbluemle
1
Ya, di sini: oracle.com/technetwork/java/javase/documentation/… - meskipun tersirat daripada eksplisit.
SeverityOne
Tidak mengerti mengapa jawaban ini tidak memiliki lebih banyak suara positif.
John Smith
8

Daftar bertingkat harus berada di dalamnya sendiri <li>. <ul>bukan elemen turunan yang valid dari <ul>.

Jadi contoh Anda adalah:

<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>
Drew Noakes
sumber
Kode Anda menghasilkan daftar dengan item kosong. Meskipun bersarang dengan benar di HTML, hasil yang diberikan jelek.
naXa