Если я пишу <xmlElement>
в javadoc, он не появляется, потому что теги имеют специальные функции при форматировании текстов.
Как показать эти символы в javadoc?
Если я пишу <xmlElement>
в javadoc, он не появляется, потому что теги имеют специальные функции при форматировании текстов.
Как показать эти символы в javadoc?
Вы можете использовать <
для < и >
для .
Последние версии поддержки JavaDoc {@literal A <B> C}; это правильно выводит контент (экранирование "<" и " > " в сгенерированном HTML).
См. http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html
Учитывая, что XML - это реальный код, я считаю, что фрагменты XML в Javadoc лучше подходят для тега {@code A <B> C}, а не тега {@literal A <B> C}.
Тег {@code} использует шрифт с фиксированной шириной, который делает его контент выдающимся как действительный код.
Сбросьте их как HTML: <
и >
Вам нужно использовать только эквивалент HTML для одного из угловых скобок. <
может быть представлен как <
или <
. Здесь образец, взятый из реального Javadoc:
<pre> <complexType> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> [...]
Это отображается как:
<complexType>
<complexContent>
<restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
<sequence>
Если вы установите maven для использования уценки, вы можете просто окружить его обратными окнами.
`A<B>C`
читается немного лучше {@code A<B>C}
Вставка & lt; pre & gt; и {@code} сохраняет angular скобки и пустые строки в javadocs и широко используется, см., например, java.util.Stream.
<pre>{@code
A<B>C
D<E>F
}</pre>
Просто окружите его {@code}
следующим образом:
{@code <xmlElement>}