Изучаем Java

Вы здесь: Главная >> Java-самоучитель >> Документирование кода

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


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

Рассмотрим документирование кода. Мы изучим технологию создания документации с помощью утилиты javadoc. В листинге 5.5 представлен пример простого документирования кода.

Листинг 5.5.
Пример документирования кода

В комментариях нужно использовать теги, иначе javadoc откажется правильно работать. Они предназначены для специфического отображения текста. Все теги начинаются с символа @.

Давайте рассмотрим некоторые из них.

Приведем пример уже созданной программы с документированием кода с помощью тегов (листинг 5.6).

Листинг 5.6.
Пример программы с документированием кода с помощью тегов

Немного о принципе многопоточности

Многопоточность — это принцип построения программы, при котором несколько блоков могут выполняться одновременно и не мешать друг другу. Предположим, нам необходимо, чтобы какие-то операции выполнялись одновременно.
Например, у нас существует два объекта, выполняющие конкретные операции независимо друг от друга. Но они используют один и тот же метод, который добавляет к статической переменной число, передаваемое методу в параметре. Однако если эти операции будут выполняться одновременно, то непонятно будет, что запишется в этой переменной, ведь мы одновременно прибавляем к исходному значению переменной два разных числа.

Возникнет странная ситуация. Для того чтобы такого не происходило, для этого метода необходимо установить так называемый признак блокировки. Если какой-либо объект начинает выполнять метод, то происходит блокировка этого метода, и никто больше не может его выполнить, пока данный объект не закончит работу с ним. Все другие объекты, которые должны выполнить этот метод, будут находиться в состоянии ожидания.

Создание потоков на основе класса Thread

Чтобы создать свой поток, необходимо создать дочерний класс класса Thread. Давайте создадим такой класс и затем разберем весь текст программы (листинг 5.7).

Листинг 5.7.
Создание потока на основе класса Thread

Вначале мы создаем дочерний класс для класса Thread, затем — конструктор с параметром, который установит количество секунд выполнения потока. После этого мы определяем метод run. который начинает действовать при запуске потока.
Чтобы его вызвать, необходимо вызвать метод start () — "стартовать поток".

У класса Thread есть метод sleep, который позволяет приостановить выполнение потока на заданное количество миллисекунд (внимание: отсчет идет в миллисекундах). Чтобы использовать данный метод, необходимо поместить его в блок try, а блок catch сделать обрабатывающим исключение InterruptedException. Затем мы запускаем два потока, которые будут выполняться одновременно. Чтобы их различить, можно переделать код так (листинг 5.8).

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

Теперь мы каждому потоку присвоили свой уникальный номер.

Использование интерфейса Runnable

Можно создавать классы потоков, реализуя интерфейс Runnable. Это бывает порой значительно удобнее. Например, код из предыдущего примера можно переписать так (листинг 5.9).

Листинг 5.9.
Создание классов потоков с использованием интерфейса Runnable

В некоторых случаях так представляется удобней: обычно у подобного создания потоков более короткая запись.
И в том и в другом случае потоку можно присвоить имя. Обычно оно задается в конструкторе в качестве последнего параметра.


Партнеры сайта