Какой тег следует использовать как разделитель абзацев в Javadoc?

Ответ 1

Добро пожаловать на сайт HTML 3.2.

Согласно официальному руководству по написанию комментариев к док-тегу, правильный способ разделения абзацев заключен в теге абзаца: <P>. Взгляните на седьмую пулю в разделе Формат комментария Doc.

Обычно я настоятельно рекомендую не использовать такие старые, устаревшие практики для разметки. Однако в этом случае есть приличная причина для исключения. Инструмент JavaDoc (если он не обновляется с помощью пользовательских Doclets) генерирует старую, жестокую, несколько сломанную разметку. Браузеры были созданы, чтобы быть обратно совместимыми с сумасшедшей старой разметкой дня, поэтому имеет смысл для вас просто согласиться с этим. Ваше использование <P> для разделения абзацев будет соответствовать остальной части выхода JavaDoc.

Ответ 2

Строго говоря, самозакрывающийся <p /> не имеет смысла, поскольку <p> следует использовать для содержания абзаца, т.е. параграф должен быть заключен в рамки <p> и </p>.

<br>, однако, является тегом "нижнего уровня", который указывает на разрыв строки. Таким образом, семантически правильный способ указывать абзацы состоял бы в использовании <p>:

<p>This Foo is used to frobincate a {@link Baz}.</p>
<p>It is quite groovy!</p>

против.

This Foo is used to frobincate a {@link Baz}.<br>
It is quite groovy!

Визуально <p> приводит к появлению большего количества пробелов между строками, а <br> только начинает новую строку и не вводит никаких крупных пробелов.

Ответ 3

С Java 8 работает один стартовый элемент (<p>).

Обратите внимание, что javadoc не нравится закрывающий элемент (</p>).

Ответ 4

просто используйте <br/>, он отлично работает.