Como criar vários níveis de indentação em Javadoc?


88

Suponha que, como parte da documentação de seu código (Javadoc), você deseja indicar que as relações entre os elementos usam recuo profundo.

Como posso criar uma lista aninhada como:

  • algum elemento
    • algum outro elemento
      • ainda algum outro elemento

Respostas:


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

Você pode usar HTML com bastante liberdade dentro de comentários javadoc.

Atualização: porque surgiu, tentei

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

e pegue

  • 1
    • um ponto um

Eu concordo que o aninhamento adequado é melhor.


2
Eu diria que <ul> aninhado deve estar dentro de algum elemento <li>, para comparação, consulte w3.org/wiki/HTML_lists#Nesting_lists
user2622016

Você pode dizer isso, mas tentar diz algo diferente.
Charlie Martin

1
@Charlie Em vez de dizer "Concordo que o aninhamento adequado é melhor", talvez você pudesse escrever um exemplo mostrando como aninhar corretamente. Caso contrário, talvez algum iniciante não entenda Seu comentário e use o formulário mencionado acima.
Rauni Lillemets

2
Eu entendi que user2622016 significava que você tem que escrever assim: <ul><li><ul>...</ul></li> </ul>, para que o mais íntimo <ul> .. </ ul > também está dentro de um bloco <li> .. </li>.
Rauni Lillemets

1
Embora eu não possa encontrar explicitamente declarado (e eu procurei), é o estilo que é usado na documentação da Oracle . Além disso, o NetBeans reclama disso. A Intellij, por outro lado, adiciona alegremente as </li>tags
SeverityOne

28

A maneira correta é a seguinte:

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

Embora o JavaDoc se baseie em HTML, não é HTML e você deve omitir as </li>tags, assim como deve omitir as </p>tags.


1
Alguma referência à omissão das tags de fechamento?
friederbluemle

1
Sim, aqui: oracle.com/technetwork/java/javase/documentation/… - embora seja implícito em vez de explícito.
SeverityOne

Não entendo por que essa resposta não tem mais votos positivos.
John Smith

8

A lista aninhada deve estar dentro de sua própria lista <li>. <ul>não é um elemento filho válido de <ul>.

Então, seu exemplo seria:

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

Seu código resulta em uma lista com itens vazios. Embora esteja devidamente aninhado no HTML, o resultado renderizado é feio.
naXa de
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.