Программирование на JAVA
Меню :
Стартовая
Основы программирования
Программирование на JAVA
Программирование на C++
Программирование на Pascal
Задачи по программированию
Из этого комментария будет сгенерирован HTML-код, выглядящий примерно так:
Первое предложение - краткое описание метода.
Так оформляется пример кода:
if (condition==true) { x = gerWidht(); у = x.getHeight();
}
А так описывается HTML-список:
• Можно использовать наклонный шрифт курсив,
• или жирный жирный.
Наконец, javadoc поддерживает специальные теги. Они начинаются с символа @. Подробное описание этих тегов можно найти в документации. Например, можно использовать тег @see, чтобы сослаться на другой класс, поле или метод, или даже на другой Internet-сайт.
* Краткое описание.
* Развернутый комментарий.
*
* @see java.lang.String
* @see java.lang.Math#PI
* @see <a href="java.sun.com">Official Java site</a>
7
Первая ссылка указывает на класс String Qava.lang - название библиотеки, в которой находится этот класс), вторая - на поле PI класса Math (символ # разделяет название класса и его полей или методов), третья ссылается на официальный сайт Java.
Комментарии разработчика могут быть записаны перед объявлением классов, интерфейсов, полей, методов и конструкторов. Если записать комментарий /**...*/ в другой части кода, то ошибки не будет, но он не попадет в документацию, генерируемую javadoc. Кроме того, можно описать пакет (так называются библиотеки, или модули, в Java). Для этого необходимо создать специальный файл package.html, сохранить в нем комментарий и поместить его в каталог пакета. HTML-текст, содержащийся между тегами <body> и </body>, будет помещен в документацию, а первое предложение будет использоваться для краткой характеристики этого пакета.
Все классы стандартных библиотек Java поставляются в виде исходного текста и можно увидеть, как хорошо они комментированы. Стандартная документация по этим классам сгенерирована утилитой javadoc. Для любой программы также можно подготовить подобное описание, необходимы лишь грамотные и аккуратные комментарии в исходном коде. Кроме того, Java предоставляет возможность генерировать с помощью javadoc документацию с нестандартным внешним видом.
Лексемы
Итак, мы рассмотрели пробелы (в широком смысле этого слова, т.е. все символы, отвечающие за форматирование текста программы) и комментарии, применяемые для ввода пояснений к коду. С точки зрения программиста они применяются для того, чтобы сделать программу более читаемой и понятной для дальнейшего развития.
