Программирование на языке Java


Комментарии



Комментарии

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

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

Третья, особая форма комментариев, предназначена для сервисной программы javadoc, которая использует компоненты Java-транслятора для автоматической генерации документации по интерфейсам классов. Соглашение, используемое для комментариев этого вида, таково: для того, чтобы разместить перед объявлением открытого (public) класса, метода или переменной документирующий комментарий, нужно начать его с символов /** (косая черта и две звездочки). Заканчивается такой комментарий точно так же, как и обычный комментарий - символами */. Программа javadoc умеет различать в документирующих комментариях некоторые специальные переменные, имена которых начинаются с символа @. Вот пример такого комментария: /** * Этот класс умеет делать замечательные вещи. * Советуем всякому, кто * захочет написать еще более совершенный класс, * взять его в качестве базового. * @see Java. applet. Applet * (c)author Patrick Naughton * @version 1. 2 */ class CoolApplet extends Applet { /** * У этого метода два параметра: * @param key - это имя параметра. * @param value - это значение параметра с именем key. */ void put (String key, Object value) {









Начало  Назад  Вперед


Книжный магазин