Методы
Последняя часть программы состоит в определении методов.
Методы реализуют определенное поведение и действия, которые объект может выполнять.
Каждое объявление метода имеет 5 основных компонентов.
Первым идет идентификатор доступа.
public метод может быть доступен для всех других классов, а доступ к private методу можно получить только в пределах одного класса.
Далее идет возвращаемый тип метода, который является типом данных значения, возвращаемого методом.
Например, метод может возвращать целочисленное значение, тогда возвращаемый тип может быть одним из четырех примитивных типов целых чисел, в том числе, byte, short, int и long.
Если метод возвращает число с плавающей точкой, возвращаемый тип может быть float или double.
Кроме того, возможно, что никакое значение не возвращается методом, в этом случае используется тип void.
Далее идет имя метода.
Любой допустимый идентификатор Java может быть использован в качестве имени метода.
По соглашению в качестве имени метода используется нижний CamelCase.
Далее идет список параметров.
Список параметров является списком пар тип-параметр, разделенных запятыми. И список параметров окружен скобками, даже если список параметров пуст.
И наконец, идет тело метода.
Тело метода окружено парой фигурных скобок. И тело метода часто делится на две основные части.
Первая часть, это декларация локальных переменных и вторая часть состоит из Java выражений, которые делают реальную работу.
В примере NewClass, определяется метод с именем sampleMethod.
Доступность метода является public. А тип значения, возвращаемого методом, является int.
В списке параметров существует только один параметр с типом int.
Тело метода имеет только один оператор, return х + у, где х является переменной экземпляра, объявленной в начале, и у является параметром, передаваемым в метод.
Обратите внимание, что слово return здесь это ключевое слово Java.
Выражение «х + у» будет складывать две переменные и результат, который имеет тип int, будет возвращаемым значением метода sampleMethod.
Если мы вернемся к примеру с автомобилем, вы обнаружите, что объявление класса Car следует той же структуре.
Оно начинается с заголовка, который определяет название класса, в этом случае, Car.
Тело объявления Car начинается с объявления переменной экземпляра.
После объявления переменных следует декларация конструктора.
Конструкторы используются для создания новых экземпляров объектов и в этом случае есть два конструктора. Один без параметров, другой с одним параметром строкового типа.
После объявления конструкторов следуют объявления методов.
Здесь определены три метода.
Два из методов имеют тип void.
Это означает, что методом не возвращается значение.
Оба метода печатают сообщение в консоли о действиях, которые они призваны выполнять.
Метод moveCar также изменяет значение одной из переменных экземпляра, счетчик километража.
Третий метод getsOdometer возвращает значение одометра, который имеет int тип.
Метод, который возвращает значение закрытого поля, часто называют getter методом.
Вопросы
Обсуждение отладки.
Давайте попробуем определить все ошибки в следующем классе IronMan.
Ответ:
Комментарии
Прежде чем мы двинемся дальше, давайте поговорим о программной документации.
Как уже говорилось, документирование программы важно, потому что также как и компьютер, другие люди могут также читать вашу программу, которая представлена для широкой публики.
Кто бы ни оценивал вашу программу, он должен понимать, как работает ваша программа, даже если она не работает, чтобы быть в состоянии помочь вам в определении проблемы.
Документация поможет сопровождению программы и в случае, если программа может быть изменена в будущем.
Программная документация предоставляется в виде комментариев.
Как правило, комментарии используются для описания следующих аспектов программы:
– Что программа делает и что требует, например, описание спецификации входных и выходных данных;
– Что представляют собой переменные, и использование значимых имен здесь также поможет;
– Что следует учитывать при использовании переменных или методов, например, описание диапазона допустимых входных данных и типов параметров, ожидаемых методом;
– Краткое описание логического потока программы;
– Некоторые сведения об авторе и самом коде, так что люди смогли с вами связаться, если обнаружат проблемы с кодом.
И есть три основных способа, чтобы расположить комментарии в коде, так, чтобы компьютер не рассматривал их как часть программного кода.
Комментарии, которые помещаются на одной строке, предваряются двумя косыми чертами (/ /).
Все, что написано в строке за двойными косыми чертами будет рассматриваться как комментарии.
Строка комментариев обычно помещается на верху или на правой стороне программного выражения.
Блок комментариев может быть заключен между / * и * / в одну или несколько строк, и все между этими разделителями будет рассматриваться как комментарии.
Это обычно используется, когда подробное описание требуется для объяснения набора выражений программирования, содержащихся в блоке кода.
Javadoc является полезным инструментом для генерации документации автоматически из программ Java.
Комментарии Javadoc написаны между двумя разделителями / **, заметьте, что здесь есть две звездочки, и * /.
Комментарии могут занимать несколько строк и все между двумя такими разделителями будет рассматриваться как комментарии.
Javadoc также предоставляет некоторые полезные описательные теги, два самые полезные из них включают @param для описания параметров, используемых в методе или конструкторе, и @return используется для описания возвращаемого методом значения.
В результате работы инструмента Javadoc генерируется документ в формате HTML, который может быть отображен как веб-страница.
В NewClass, например, разделы комментариев синего цвета могут быть извлечены в Javadoc.
Это описательные теги.
Для метода, определенного здесь, дано описание для параметра у и значения, возвращаемого методом.
В IntelliJ IDEA сгенерировать Javadoc документацию для проекта можно соответствующей командой меню.
В общем, Javadoc начинается с общего описания и резюме конструкторов и методов, которые сопровождаются подробным описанием.
Например, вы можете посмотреть здесь подробное описание для метода sampleMethod, включая описание для параметров и значения, возвращенного методом.
И формат Javadoc считается отраслевым стандартом для документирования классов Java.
Вы увидите, что все популярные Java библиотеки, очень хорошо задокументированы. И вы должны усвоить привычку писать хорошо документированные программы.
