Looking for java Answers? Try Ask4KnowledgeBase
Looking for java Keywords? Try Ask4Keywords

Java LanguageДокументирование кода Java


Вступление

Документация для Java-кода часто создается с помощью javadoc . Javadoc был создан Sun Microsystems с целью генерации документации API в формате HTML из исходного кода Java. Использование формата HTML дает удобство гиперссылки связанных документов вместе.

Синтаксис

  • / ** - запуск JavaDoc в классе, поле, методе или пакете
  • @author // Чтобы назвать автора класса, интерфейса или перечисления. Требуется.
  • @version // Версия этого класса, интерфейса или перечисления. Требуется. Вы можете использовать макросы, такие как% I% или% G%, для программного обеспечения для управления исходным кодом, которое необходимо заполнить при оформлении заказа.
  • @param // Чтобы показать аргументы (параметры) метода или конструктора. Укажите один тег @param для каждого параметра.
  • @return // Чтобы показать типы возвращаемых значений для непустых методов.
  • @exception // Показывает, какие исключения могут быть выбраны из метода или конструктора. Исключения, которые ДОЛЖНЫ быть пойманы, должны быть перечислены здесь. Если вы хотите, вы можете также включить те, которые не нужно захватывать, например ArrayIndexOutOfBoundsException. Укажите одно исключение @ для каждого исключения, которое может быть выбрано.
  • @throws // То же, что @exception.
  • @see // Ссылки на метод, поле, класс или пакет. Используйте в виде package.Class # что-то.
  • @since // Когда этот метод, поле или класс были добавлены. Например, JDK-8 для класса, такого как java.util.Optional <T> .
  • @serial, @serialField, @serialData // Используется для отображения serialVersionUID.
  • @deprecated // Чтобы пометить класс, метод или поле как устаревшие. Например, будет java.io.StringBufferInputStream . Смотрите полный список существующих устаревших классов здесь .
  • {@link} // Подобно @see, но может использоваться с пользовательским текстом: {@link #setDefaultCloseOperation (int closeOperation) см. JFrame # setDefaultCloseOperation для получения дополнительной информации}.
  • {@linkplain} // Похож на {@link}, но без шрифта кода.
  • {@code} // Для буквенного кода, например, HTML-тегов. Например: {@code <html> </ html>}. Однако это будет использовать моноширинный шрифт. Чтобы получить тот же результат без моноширинного шрифта, используйте {@literal}.
  • {@literal} // То же, что и {@code}, но без моноширинного шрифта.
  • {@value} // Показывает значение статического поля: значение JFrame # EXIT_ON_CLOSE равно {@value}. Или вы можете ссылаться на определенное поле: Использует имя приложения {@value AppConstants # APP_NAME}.
  • {@docRoot} // Корневая папка JavaDoc HTML относительно текущего файла. Пример: <a href="{@docRoot}/credits.html"> Кредиты </a>.
  • HTML разрешен: <code> «Привет cookies» .substring (3) </ code>.
  • * / - конец объявления JavaDoc

замечания

Javadoc - это инструмент, входящий в состав JDK, который позволяет конвертировать комментарии в коде в документацию HTML. Спецификация Java API была сгенерирована с использованием Javadoc. То же самое можно сказать и о большей части документации сторонних библиотек.

Документирование кода Java Связанные примеры