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


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

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

  • какой-то элемент
    • какой-то другой элемент
      • еще какой-то элемент
3   51   2011-06-25 19:43:01

3 ответа:

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

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

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

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

и вам

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

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

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

правильный путь заключается в следующем:

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