Комментарии и встроенная документация. Спецификаторы доступа к классам и полям класса в Java. public, protected и private

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

Комментарии, занимающие одну строку, начинаются с символов // и заканчиваются в конце строки. Такой стиль комментирования полезен для размещения кратких пояснений к отдельным строкам кода: а = 42; // если 42 - ответ, то каков же был вопрос?

Для более подробных пояснений вы можете воспользоваться комментариями, размещенными на нескольких строках, начав текст комментариев символами /* и закончив символами */ При этом весь текст между этими парами символов будет расценен как комментарий и транслятор его проигнорирует.

/*

* Этот код несколько замысловат...*/

Третья, особая форма комментариев, предназначена для сервисной программы javadoc, которая использует компоненты Java-транслятора для автоматической генерации документации по интерфейсам классов. Соглашение, используемое для комментариев этого вида, таково: для того, чтобы разместить перед объявлением открытого (public) класса, метода или переменной документирующий комментарий, нужно начать его с символов /**. Заканчивается такой комментарий точно так же, как и обычный комментарий - символами */. Программа javadoc умеет различать в документирующих комментариях некоторые специальные переменные, имена которых начинаются с символа @. Вот пример такого комментария:

/**

* Этот класс умеет делать замечательные вещи.

* @version 1. 2

*/ /**

Встроенная документация. Для автоматической генерации документации по вашему классу необходимо в тело класса вставить специальные комментарии. Все команды javadoc обрабатываются только внутри комментариев типа:

/**

*/

Такие комментарии необходимо вставить перед самим классом, перед всеми полями и методами класса.Пример:

/**

*@autor glotova

*@version 0.1

*/

public class docTest {

/**

*Комментарии к полю

*/

int i;

/** * @param name – имя клиента*/

public int getAge(String name) }

Спецификаторы доступа. В Java различают спецификаторы доступа к самому классу и данным класса.

Спецификаторы доступа к данным класса:

public – доступ к члену класса возможен из любого объекта программы.

protected – доступ к члену класса разрешен любому экземпляру класса, всем его классам потомкам, а также всем другим классам пакета.

private – доступ к члену класса разрешен только экземплярам данного класса.

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

Спецификаторы доступа к самому классу:

public- делает класс открытым, то есть доступным другим классам.

Если спецификатор данных не задан явно, то к этому классу имеют доступ все классы пакета.


Понравилась статья? Добавь ее в закладку (CTRL+D) и не забудь поделиться с друзьями:  



double arrow
Сейчас читают про: