Философия Java


Вставка HTML


Javadoc пропускает HTML команды для генерации HTML документа. Это позволяет вам использовать HTML; однако главный мотив состоит в позволении вам форматировать код, например так:

/** * <pre> * System.out.println(new Date()); * </pre> */

Вы также можете использовать HTML, как вы это делаете в других Web документах для форматирования обычного текста вашего документа:

/** * Вы можете <em>даже</em> вставить список: * <ol> * <li> Первый элемент * <li> Второй элемент * <li> Третий элемент * </ol> */

Обратите внимание, что внутри комментариев-документации звездочки в начале строки выбрасываются javadoc вместе с начальными пробелами. Javadoc переформатирует все так, что документ принимает внешний вид стандартного. Не используйте заголовки, такие как <h1> или <hr> в качестве встраиваемого HTML, потому что javadoc вставляет свои собственные заголовки, и вы можете запутаться в них.

Все компоненты документации — класс, переменная и метод — могут поддерживать вставку HTML.




Начало  Назад  Вперед