Просмотр исходного текста страницы LXF84:Java

=== Героический объект ===
Приступая к этой серии материалов, я вспомнил, что, как правило, изучение языков программирования начинается с написания приложения "Hello World!", но такой прием настолько изъезжен, что я намереваюсь предложить пример поинтереснее: мы напишем приложение, рассказывающее сказку. Основа приложения – два класса. Каждый класс содержит члены двух видов: атрибуты и методы. Атрибуты – это данные, принадлежащие самому классу. Совокупное значение атрибутов определяет состояние объекта или класса. Метод – это последовательность операторов, изменяющих значения атрибутов и, как следствие, состояние класса или объекта.

В каждой интересной сказке должен быть свой герой. Предлагаю взглянуть на класс, который реализует нашего героя. Итак, по порядку. Следующий код необходимо сохранить в файл '''FirstHero.java.'''
<source lang = "java">
public class FirstHero {
  private String quest;
  public FirstHero(String Quest) {
    this.quest = Quest;
  }
  public void setQuest(String Quest){
    this.quest = Quest;
  };
  public String getQuest(){
    return quest;
  };
}
</source>
Расположение одного класса в одном файле считается хорошим тоном среди программистов на Java – так что приучайтесь к нему сразу. Имя файла должно совпадать с названием класса, расширение у файла – '''.java.'''

Первый созданный нами класс содержит один защищенный атрибут (private – модификатор, зарезервированное слово, которое обеспечивает возможность обращения к члену класса только внутри класса) и три открытых метода (public – модификатор, зарезервированное слово, которое обеспечивает возможность обращения к члену класса из любого другого класса.). Хорошо спроектированный класс не имеет открытых атрибутов, что позволяет быть уверенным в правильной работе с ними. Доступ к защищенным атрибутам осуществляется через открытые методы. Такая организация класса позволяет разработчику через методы реализовать различные проверки и исключить неправильное поведение объекта. Класс представляет собой объединение атрибутов и методов в единое целое – подобное объединение называется инкапсуляцией.

Вы можете заметить, что первый метод (третья строка представленного ранее листинга) имеет то же название, что и класс – FirstHero. Такой метод называется конструктором. Конструктор – это метод, который используется при создании экземпляра класса для задания внутреннего состояния объекта, например:
<source lang = "java">
FirstHero ourNewHero = new FirstHero("Спасти царевну");
</source>
Единственный атрибут нашего класса quest имеет тип строка (String). Для установки значения атрибута quest используется метод
setQuest. Метод setQuest является public и не возвращает никакого значения. Для обозначения методов, не возвращающих значение, используется зарезервированное слово void. Для вызова метода setQuest необходим обязательный параметр: Quest типа String. Для получения значения атрибута quest используется метод getQuest, который вызывается без параметров, является открытым и возвращает значение типа String.

Вызов описанных выше методов для объекта ourNewHero осуществляется следующим образом:
<source lang = "java">
ourNewHero.getQuest();
ourNewHero.setQuest("какая-то строка");
</source>
Парные методы, различающиеся приставками set и get, принято создавать для работы с закрытыми атрибутами. Это обязательное
условие для реализации объекта в виде JavaBean. Что такое JavaBean, мы обсудим позже – сейчас запомните, что такое наименование методов позволяет избавиться от ряда проблем в больших системах.

Приступим к написанию самой сказки. Возьмите следующий код и поместите его в файл '''Story.java'''.

<source lang = "java">
public class Story {
  public static void main(String[] args) {
    FirstHero ourNewHero = new FirstHero("Спасти царевну ");
    System.out.println("Наш герой хочет отправиться в путь и " + ourNewHero.getQuest());
  }
}
</source>

Это класс Story, он имеет всего один метод main, который является статичным (static-методы и переменные принято называть переменными класса и методами класса, т.к. они общие для всех объектов) и используется для работы с классом в целом. Метод main – это стартовая точка для запуска программы, с которой начинается интерпретация кода.

В ходе интерпретации метода main создается новый объект ourNewHero, а также вызывается метод println объекта out, который обеспечивает вывод в стандартный выходной поток строковойпеременной.

Откомпилируем код и увидим, что у нас получилось. Для компиляции переместитесь в каталог, где вы разместили свои файлы и выполните следующую команду:
<source lang = "java">
# javac *.java
</source>
При желании вы можете откомпилировать классы по отдельности, следующим образом:
<source lang = "java">
# javac Story.java
# javac FirstHero.java
</source>
В итоге вы получите два файла '''Story.class''' и '''FirstHero.class'''. Теперь посмотрим на результат:
<source lang = "java">
# java Story
Наш герой хочет отправиться в квест и Спасти царевну
</source>

Первая программа на Java готова и работает! Вы создали два класса и научились выводить информацию в консоль. Но мы забыли о
комментариях...

Комментарии бывают нескольких типов:
*Строчные начинаются с символа // и длятся до окончания строки.
*Многострочные комментарии заключаются между /* и */.
*Комментарии JavaDoc – это многострочные комментарии, заключенные между /** и */, например:

<source lang = "java">
/**
 * Класс является прототипом объекта "герой"
 * @author Chernousov Anton
 * @version 0.1
 */
public class FirstHero {
…
/**
   * Метод предназначен для установки внутренней переменной
quest
   * в значение Quest.
   * У этого метода один параметр
   * @param Quest это переменная означает задание для Героя
   */
  public void setQuest(String Quest)
…
</source>

Комментарии JavaDoc предназначены для формирования документации к проекту из исходных кодов. Если добавить в файл '''FirstHero.java''' только что приведенные строки, то с помощью команды '''javadoc -author -version *.java''' можно сформировать документацию к нашему проекту.

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