Как создать несколько уровней отступов в Javadoc?

Question

Предположим, что в рамках документирования вашего кода (Javadoc) вы хотите указать, что в отношениях между элементами используется глубокий отступ.

Как создать вложенный список как:

• какой-то элемент
  • какой-то другой элемент
    • еще какой-то другой элемент

Answer 1

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

Вы можете довольно свободно использовать HTML внутри комментариев Javadoc.

Обновление: потому что оно подошло, я попытался

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

и получите

• один
• одна точка один

Я согласен, что правильное вложение лучше.

Answer 2

Правильный путь таков:

/**
 * <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>.

Answer 3

Вложенный список должен быть в пределах его <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>