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


88

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

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

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

Ответы:


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

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

Обновление: поскольку оно появилось, я попробовал

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

и получить

  • один
    • один балл

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


2
Я бы сказал, что вложенный <ul> должен находиться внутри некоторого элемента <li>, для сравнения см. W3.org/wiki/HTML_lists#Nesting_lists
user2622016 05

Вы можете так сказать, но попытка говорит о другом.
Чарли Мартин

1
@Charlie Вместо того, чтобы говорить: «Я согласен, что правильное размещение лучше.», Может быть, вы могли бы написать пример, показывающий, как правильно размещать? В противном случае, возможно, кто-то из новичков не поймет Ваш комментарий и воспользуется вышеуказанной формой.
Рауни Лиллеметс

2
Я так понял, что user2622016 имел ввиду, что Вы должны написать вот так: <ul><li><ul>...</ul></li> </ul>, чтобы самый внутренний <ul> .. </ ul > также находится внутри блока <li> .. </li>.
Рауни Лиллеметс

1
Хотя я не могу найти его явно заявленного (и я смотрел), это стиль, который используется в документации Oracle . Кроме того, NetBeans жалуется на это. Intellij, с другой стороны, с радостью добавляет </li>теги
SeverityOne

28

Правильный способ выглядит следующим образом:

/**
 * <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>теги.


1
Есть ссылки на отсутствие закрывающих тегов?
Friederbluemle

1
Да, здесь: oracle.com/technetwork/java/javase/documentation/… - хотя это неявно, а не явно.
SeverityOne

Не понимаю, почему этот ответ не получил больше голосов.
Джон Смит

8

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

Результатом вашего кода будет список с пустыми элементами. Хотя он правильно вложен в HTML, полученный результат уродлив.
naXa
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.