Объектно-ориентированное программирование на Java. Платформа Java SE. Тимур Машнин

Чтение книги онлайн.

СКАЧАТЬ style="font-size:15px;">      Мы начнем с определения Javadoc-комментария.

      Комментарий Javadoc написан в формате HTML и должен предшествовать коду.

      Он состоит из двух частей: описания и блока тегов.

      Рассмотрим теги, которые вы должны использовать и как их использовать.

      Давайте посмотрим на метод, который здесь указан, и вид информации, которая должна быть предоставлена для него в Javadoc.

      Вы должны начать свой комментарий Javadoc с краткого и полного описания того, что делает этот метод.

      Если в вашем Javadoc-комментарии есть несколько абзацев, разделите их тэгом p.

      Затем вставьте пустую строку комментария, между описанием и блоком тегов.

      Обратите внимание, что каждый комментарий Javadoc имеет только одно описание.

      И как только инструмент Javadoc найдет пустую строку, он решит, что описание закончено.

      Затем вы используете теги для добавления информации о вашем методе.

      Наконец, вы должны поместить в конце строку со звездочкой и косой чертой, чтобы отметить конец комментария Javadoc.

      Какая информация должна быть включена в блок тегов?

      Для описания метода нам понадобятся, в основном, два типа тегов – @param и @return.

      @param описывает аргумент метода.

      И его необходимо указать для всех аргументов метода.

      За тегом всегда следует имя аргумента.

      Это имя всегда указывается в нижнем регистре.

      Затем идет описание аргумента.

      Далее вы должны всегда указывать тип данных аргумента.

      Единственным исключением является тип данных, int, который вы можете опустить.

      Чтобы разделить имя, описание и тип данных аргумента, вы можете добавить один или несколько пробелов.

      Теги @param должны быть перечислены в порядке объявления аргумента.

      Что касается описания, если это фраза без глагола, начните его с маленькой буквы.

      Если это предложение с глаголом, начните его с заглавной буквы.

      Таким образом, Javadoc – это полезный инструмент, который позволяет программистам автоматически генерировать HTML-страницы с документацией из их кода.

      Исключения

      Когда мы говорили о том, что мы можем сделать в случае метода, который не определен для всех возможных входных значений, мы сказали, что мы можем запрограммировать, что нужно сделать в исключительной ситуации.

      То есть мы можем программировать, что делать в обычных случаях, и что делать в исключительных случаях.

      Это сделает нашу программу более надежной.

      Таким образом, у нас есть исключения.

      В этом случае мы используем не комментарии, а используем конструкции программирования языка Java.

      Мы программируем, что делать для значений, которые не желательны.

      Часто бывает, что наши программы СКАЧАТЬ