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

Question

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

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

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

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

343 3

documentation javadoc indentation nested-lists

3 ответов:

Comments

Ничего не найдено.

Charlie Martin · Accepted Answer · 2016-08-09 17:51:54

<ul>
  <li>Element</li>
  <ul>
     <li>Subelement...</li>
вы можете довольно свободно использовать HTML внутри комментариев javadoc.

обновление: потому что он пришел, я попытался
<ul>
    <li>one</li>
    <ul>
        <li>one point one</li>
    </ul>   
</ul>
и вам

один

одна точка

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

Drew Noakes · Accepted Answer · 2016-09-18 17:24:24

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

SeverityOne · Accepted Answer · 2018-04-18 09:51:32

правильный путь заключается в следующем:
/**
 * <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> теги.