documentation - ¿Cómo crear múltiples niveles de sangría en Javadoc?

java documentation 8

Question

Supongamos que, como parte de la documentación de su código (Javadoc), desea indicar que las relaciones entre los elementos utilizan una sangría profunda.

¿Cómo puedo crear una lista anidada como:

• algun elemento
  • algún otro elemento
    • sin embargo, algún otro elemento

Answer 1

La forma correcta es la siguiente:

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

Aunque JavaDoc toma prestado de HTML, no es HTML, y debe omitir las etiquetas </li> , tal como debería omitir las etiquetas </p> .

Answer 2

La lista anidada debe estar dentro de su propio <li> . <ul> no es un elemento hijo válido de <ul> .

Entonces tu ejemplo sería:

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

Answer 3

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

Puedes usar HTML bastante libremente dentro de los comentarios de javadoc.

Actualización: porque surgió, lo intenté

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

y obten

• uno
• un punto uno

Estoy de acuerdo en que la anidación apropiada es mejor