Як створити кілька рівнів відступу в 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

Ви можете сказати це, але спробувати це говорить про щось інше.
Charlie Martin

1
@Charlie Замість того, щоб сказати "Я згоден, що правильне вкладання краще.", Можливо, ви можете написати приклад, який показує, як правильно вкладатись? В іншому випадку, можливо, якийсь початківець не зрозуміє Вашого коментаря та скористається вищезазначеною формою.
Rauni Lillemets

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/… - хоча це неявно, а не явно.
Severity,

Не розумію, чому ця відповідь не має більше голосів.
Джон Сміт

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.