Комментарии в программах на Паскале
06.09.2018 7522 Программируем на Паскале Ваш комментарийНа этом уроке мы познакомимся с очень важным инструментом Паскаля — с комментариями. Когда я говорю, что механизм этот важен, я ни на минуту не преувеличиваю. Подумайте сами, при всей жёсткости структуры программ в Паскале — при строгой привязке её кусков по месту, комментарии — единственный конструктив языка, который можно размещать где угодно, важно лишь правильно его оформить. Когда ваша программа написана, отлажена и скомпилирована, в комментариях более нет нужды, но на этапе отладки, когда вы только её пишете, а может быть, работаете в группе с другими разработчиками, комментарии будут незаменимы.
На прошлом уроке мы с вами написали первую программу «Hello, World!», сегодня мы откроем её листинг и добавим туда несколько комментариев. Урок позволит нам разобраться с тем, какие вообще бывают комментарии в Паскале, а также, мы оставим для себя самих пометки в программе, что она делает и как написана.
Откройте листинг программы HelloWorld.pas.
С какого-то момента я решил делиться написанными мной программами с вами, и для этой цели завёл репозиторий на сайте github.com. И если вы по какой-либо причине не повторяли у себя моих уроков, у вас всё же есть возможность получить доступ к листингам программ. Скачивайте их и используйте, это — бесплатно.
Итак, что же такое комментарий? Это оформленный особым образом кусок текста, который игнорируется средой разработки при исполнении и компиляции проекта, рассказывающий нам — программистам о том или ином куске программы. И раз уж PascalABC не исполняет этот кусок кода, то писать комментарии будем по-русски.
Сначала поговорим о типах комментариев. Они бывают однострочными или многострочными. Однострочный комментарий должен начинаться с двух косых чёрточек, написанных подряд без пробелов «//» и вообще говоря, не обязан начинаться с самого начала строки. Понимаю, путанное объяснение, но пока важно понять, что такой комментарий начинается с косых чёрточек и всегда заканчивается на этой же строке, какой бы длинной она не была. Следующая строка, если только она не начинается двумя слешами, интерпретируется средой разработки как строка кода.
Многострочные комментарии оформляются иначе. Здесь, очевидно, имеются как символ начала комментария, так и символ его завершения. Всё, что вы разместите между символами «(*» и «*)» или «{» и «}» компилятор будет интерпретировать как комментарий. И не важно, сколько при этом строчек в нём будет.
Перейдём к написанию комментариев. Та особенность, что однострочный комментарий может начинаться не с самого начала строки, позволяет программистам использовать их после операторов или в строчках с объявлением переменных. Мы только начали изучать Паскаль, написали лишь одну программу и всё для нас ново и непонятно. Так давайте оставим однострочные комментарии после операторов, чтобы запомнить, что они делают. Разумеется, в дальнейшем мы очень редко будем комментировать буквально каждую строку кода, но сейчас мы только учимся. В том числе, учимся оставлять комментарии.
Итак, листинг программы примет следующий вид:
program HelloWorld;
BEGIN
writeln('Привет, мир!'); // Выводим фразу на экран
readln; // Ожидание ввода с клавиатуры, заканчивается нажатием на Enter.
END.
Важно помнить о том, что всякий оператор Паскаля должен оканчиваться точкой с запятой. Поэтому проследите, чтобы ваши однострочные комментарии начинались уже после этого знака.
В статье на сайте это может быть не очевидно, но среда разработки — любая среда разработки, а не только PascalABC.Net — помечает комментарии цветом, который отличается от основного текста программы. Это позволит вам увидеть, где заканчиваются ваши комментарии, а где уже расположен код программы.
Теперь добавим многострочный комментарий. Их часто размещают перед самописными процедурами или функциями, а так же перед началом собственно программ. Это позволяет более развёрнуто изложить, чему посвящена процедура, функция или вся программа в целом. Теперь наш листинг выглядит так:
(*********************************************************
* Видеокурс по изучению языка программирования Паскаль. *
* Программа "Hello, World!" *
* Автор: Смирнов Владимир *
*********************************************************)
program HelloWorld;
BEGIN
writeln('Привет, мир!'); // Выводим фразу на экран
readln; // Ожидание ввода с клавиатуры, заканчивается нажатием на Enter.
END.
Не пугайтесь, именно так довольно часто оформляются многострочные комментарии в программах на Паскале. Смело используйте, изученный на этом уроке инструмент, а понимание его значимости придёт со временем.