Come creare più livelli di rientro in Javadoc?


89

Supponiamo che, come parte della documentazione del codice (Javadoc), si desideri indicare che le relazioni tra gli elementi utilizzano un rientro profondo.

Come posso creare un elenco nidificato come:

  • qualche elemento
    • qualche altro elemento
      • ancora qualche altro elemento

Risposte:


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

Puoi usare abbastanza liberamente l'HTML all'interno dei commenti javadoc.

Aggiornamento: perché è venuto fuori, ho provato

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

e prendi

  • uno
    • un punto uno

Sono d'accordo che una corretta nidificazione sia migliore.


2
Direi che <ul> annidato deve essere all'interno di un elemento <li>, per il confronto vedere w3.org/wiki/HTML_lists#Nesting_lists
user2622016

Puoi dirlo, ma provarlo dice qualcosa di diverso.
Charlie Martin

1
@Charlie Invece di dire "Sono d'accordo che un annidamento corretto sia migliore", forse potresti scrivere un esempio che mostri come annidare correttamente? Altrimenti, forse qualche principiante non capirà il tuo commento e utilizzerà il modulo sopra menzionato.
Rauni Lillemets

2
Ho capito che user2622016 significava che devi scrivere in questo modo: <ul><li><ul>...</ul></li> </ul>, in modo che il più interno <ul> .. </ ul > è anche all'interno di un blocco <li> .. </li>.
Rauni Lillemets

1
Anche se non riesco a trovarlo esplicitamente dichiarato (e ho guardato), è lo stile utilizzato nella documentazione di Oracle . Inoltre, NetBeans se ne lamenta. Intellij, d'altra parte, aggiunge felicemente i </li>tag
SeverityOne

29

Il modo corretto è il seguente:

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

Sebbene JavaDoc prenda in prestito dall'HTML, non è HTML e dovresti omettere i </li>tag, proprio come dovresti omettere i </p>tag.


1
Qualche riferimento per l'omissione dei tag di chiusura?
friederbluemle

1
Sì, qui: oracle.com/technetwork/java/javase/documentation/… - sebbene sia implicito piuttosto che esplicito.
Gravità Un

Non capisco perché questa risposta non abbia più voti positivi.
John Smith

8

L'elenco nidificato dovrebbe essere all'interno del proprio <li> . <ul>non è un elemento figlio valido di <ul>.

Quindi il tuo esempio sarebbe:

<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>

Il codice risulta in un elenco con elementi vuoti. Sebbene sia correttamente annidato in HTML, il risultato visualizzato è brutto.
naXa
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.