Комментарии в программах на Паскале
На этом уроке мы познакомимся с очень важным инструментом Паскаля — с комментариями. Когда я говорю, что механизм этот важен, я ни на минуту не преувеличиваю. Подумайте сами, при всей жёсткости структуры программ в Паскале — при строгой привязке её кусков по месту, комментарии — единственный конструктив языка, который можно размещать где угодно, важно лишь правильно его оформить. Когда ваша программа написана, отлажена и скомпилирована, в комментариях более нет нужды, но на этапе отладки, когда вы только её пишете, а может быть, работаете в группе с другими разработчиками, комментарии будут незаменимы.
На прошлом уроке мы с вами написали первую программу «Hello, World!», сегодня мы откроем её листинг и добавим туда несколько комментариев. Урок позволит нам разобраться с тем, какие вообще бывают комментарии в Паскале, а также, мы оставим для себя самих пометки в программе, что она делает и как написана.
Откройте листинг программы HelloWorld.pas.
С какого-то момента я решил делиться написанными мной программами с вами, и для этой цели завёл репозиторий на сайте github.com. И если вы по какой-либо причине не повторяли у себя моих уроков, у вас всё же есть возможность получить доступ к листингам программ. Скачивайте их и используйте, это — бесплатно.
Итак, что же такое комментарий? Это оформленный особым образом кусок текста, который игнорируется средой разработки при исполнении и компиляции проекта, рассказывающий нам — программистам о том или ином куске программы. И раз уж PascalABC не исполняет этот кусок кода, то писать комментарии будем по-русски.
Сначала поговорим о типах комментариев. Они бывают однострочными или многострочными. Однострочный комментарий должен начинаться с двух косых чёрточек, написанных подряд без пробелов «//» и вообще говоря, не обязан начинаться с самого начала строки. Понимаю, путанное объяснение, но пока важно понять, что такой комментарий начинается с косых чёрточек и всегда заканчивается на этой же строке, какой бы длинной она не была. Следующая строка, если только она не начинается двумя слешами, интерпретируется средой разработки как строка кода.
Многострочные комментарии оформляются иначе. Здесь, очевидно, имеются как символ начала комментария, так и символ его завершения. Всё, что вы разместите между символами «(*» и «*)» или «<» и «>» компилятор будет интерпретировать как комментарий. И не важно, сколько при этом строчек в нём будет.
Перейдём к написанию комментариев. Та особенность, что однострочный комментарий может начинаться не с самого начала строки, позволяет программистам использовать их после операторов или в строчках с объявлением переменных. Мы только начали изучать Паскаль, написали лишь одну программу и всё для нас ново и непонятно. Так давайте оставим однострочные комментарии после операторов, чтобы запомнить, что они делают. Разумеется, в дальнейшем мы очень редко будем комментировать буквально каждую строку кода, но сейчас мы только учимся. В том числе, учимся оставлять комментарии.
Итак, листинг программы примет следующий вид:
Важно помнить о том, что всякий оператор Паскаля должен оканчиваться точкой с запятой. Поэтому проследите, чтобы ваши однострочные комментарии начинались уже после этого знака.
В статье на сайте это может быть не очевидно, но среда разработки — любая среда разработки, а не только PascalABC.Net — помечает комментарии цветом, который отличается от основного текста программы. Это позволит вам увидеть, где заканчиваются ваши комментарии, а где уже расположен код программы.
Теперь добавим многострочный комментарий. Их часто размещают перед самописными процедурами или функциями, а так же перед началом собственно программ. Это позволяет более развёрнуто изложить, чему посвящена процедура, функция или вся программа в целом. Теперь наш листинг выглядит так:
Не пугайтесь, именно так довольно часто оформляются многострочные комментарии в программах на Паскале. Смело используйте, изученный на этом уроке инструмент, а понимание его значимости придёт со временем.
Комментарии
Многие сегодня хотят стать программистами. Хотят. Но ничего не делают для этого. Не делают даже простых вещей. Не хотят даже прочитать книжку из 10 страниц. В итоге так и остаются никем. Потому что мечты не сбываются никогда. Сбываются только планы… Подробнее.
Вы наверняка уже знаете, что такое комментарии. Но, быть может, знаете об этом вы ещё не всё.
Зачем нужны комментарии?
Во-первых, в начале каждого модуля или программы программист обычно указывает автора, версию, дату создания и т.п.
Во-вторых, в больших программах довольно сложно ориентироваться. Поэтому комментарии в исходных текстах очень помогают разобраться с тем, где кончается один блок кода и начинается другой.
В-третьих, есть сложные алгоритмы, разобраться в которых без комментариев трудно не только другому человеку, но и самому автору через пару недель, а тем более лет.
Комментарии Free Pascal могут быть такими:
<Это комментарий в фигурных скобках>
(* И это тоже комментарий, но уже в круглых скобках со звёздочками *)
// А это комментарий в стиле С++
Как видите, Free Pascal поддерживает несколько видов комментариев. Последний пример – это комментарии в стиле С++ (в обычном Паскале такие комментарии не предусмотрены).
Комментарий в стиле С++ начинается двумя косыми чертами и продолжается до конца строки. То есть комментарии Паскаля открываются и закрываются скобками, а комментарий в стиле С++ открывается двумя косыми чертами и действует до конца строки. А это значит, что если вы используете комментарии в стиле С++, то в начале каждой строки с комментарием вам нужно ставить две косые черты.
В каком стиле писать комментарии – это личное дело каждого. Однако лучше привыкать писать их с первых шагов в изучении программирования. Очень часто бывает, что приходится отложить работу над программой на какой то срок, либо адаптировать старую программу к новым условиям. Вернувшись к своей программе через месяц, вы уже вряд ли будете помнить ход своих мыслей в момент работы над программой, и придётся заново разбираться с исходными кодами. В некоторых случаях бывает проще написать новую программу, чем разбираться с исходными кодами старой (особенно если она плохо документирована).
Что ещё нужно знать о комментариях?
Комментарии могут быть вложенными. Например,
Как видите, вложенный комментарий ничем не отличается от обычного комментария, за исключением того, что он находится внутри другого комментария
В классических компиляторах Паскаля (например, в Turbo Pascal и Delphi), тип вложенных комментариев ОБЯЗАТЕЛЬНО должен отличаться от типа комментария, в который вложен комментарий.
То есть такой комментарий
Вызовет ошибку во время компиляции.
Free Pascal допускает вложенные комментарии одинакового типа. Хотя при компиляции в таком случае будет выдано предупреждение. Однако не следует этим злоупотреблять, так как это плохо скажется на переносимости кода.
Кроме комментариев в фигурных скобках также могут быть директивы компилятора. Выглядят они примерно так:
То есть директива компилятора начинается со знака доллара. Поэтому никогда не начинайте свои комментарии со знака доллара. Это может привести к проблемам.
Ну и напоследок привожу текст программы с разными видами комментариев.
program comment; <$mode objfpc> <$H+>//Это директива компилятора uses <$IFDEF UNIX> <$IFDEF UseCThreads>//Это тоже директива cthreads, <$ENDIF> <$ENDIF>//Это тоже директива Classes < you can add units after this >; //Это комментарий begin //Это однострочный комментарий < Этот комментарий может занимать несколько строк>(* Это тоже многострочный комментарий *) < А вот так < делать нельзя в режиме Turbo Pascal и Delphi>потому что вложенные комментарии могут быть только разных видов > < Правильный (* Вложенный комментарий *) лучше делать так >end.
Создайте программу из листинга 17.1. Откомпилируйте её и убедитесь, что всё работает без ошибок.
В директиве компилятора, которая определяет режим компиляции, замените режим objfpc на режим tp или delphi. Попробуйте откомпилировать программу. Объясните, почему возникает ошибка во время компиляции.
Pascal. Структура программы, комментарии
Структура программы
Программа, написанная на языке программирования Pascal, состоит из заголовка, раздела описаний и тела программы (блока операторов).
Для объявления заголовка необходимо указать слово Program, а затем название самой программы, например:
Имеется возможность и вовсе не определять заголовок, что не будет являться ошибкой.
Раздел описания употребляется как общее обозначение, а входят в него следующие разделы:
1) Раздел описания модулей:
Для возможности использования многих функций и процедур необходимо подключить модули (или библиотеки), которые могут быть как стандартными, так и пользовательскими.
2) Раздел описания меток:
При помощи оператора Goto можно изменить ход выполнения программы, а для его работы нужно объявить метки в разделе Label. В качестве меток используются целые числа, либо идентификаторы.
3) Раздел описания констант:
Константе (не изменяющийся величине) можно присвоить значение посредством знака =, который будет отделять его от имени константы, например:
Соnst
A = 10;
B = 0;
C = ‘C’;
Exit = ‘Exit’;
Char = оrd (‘B’) — ord (‘А’) + 1;
Тип константы зависит от ее значения, и может быть не только простым, но и выражением, а также использовать некоторые стандартные функции.
4) Раздел описания типов:
В разделе описания типов создаются пользовательские типы, которые как и стандартные можно использовать при объявлении переменных.
5) Раздел описания переменных:
В разделе Var определяются те переменные, которые будут использоваться в программе.
Var
A, B, C: Integer;
Number: Char;
Y, N: Boolean;
6) Раздел описания процедур и функций;
Процедуры и функции объявляются после раздела Var и перед телом главной программы. Данная тема требует особого подхода, и поэтому будет рассмотрена в одной из последующих статей.
Также стоит отметить, что разделы описаний, в случае их наличия, должны располагаться именно в той последовательности, в которой они описаны выше.
Раздел операторов является телом программы и представляет собой составной оператор, начало которого обозначается словом Begin, а конец – End.. Заключенный в нем операторы заканчиваются символом ;. Без этого раздела программа не имеет ни какого смысла.
В итоге у нас получилась следующая структура программы на Паскаль:
Комментарии
Не восприимчивость комментариев по отношению к компилятору делает их необязательными в программе, а их наличие лишь служит показателем хорошего тона. На ранних стадиях обучения, программисты, как правило, забывают про комментарии, либо осознано не комментируют свой код. В какой-то мере это связано с необходимостью написания крупных приложений и отсутствием опыта. Но со временем, необходимость пояснять написанное резко увеличивается.
Комментарии
Для лучшего понимания программы в нее включается пояснительный текст – комментарий. Комментарий можно записать в любом месте программы, где разрешено располагать пробелы. Текст комментария ограничивается символами < >или (* *) и может содержать любые комбинации латинских и русских букв, цифр и других символов алфавита языка Pascal. Ограничений на длину комментария нет, он может занимать несколько строк.
Комментарий игнорируется компилятором и поэтому не оказывает никакого влияния на программу. По месту расположения в программе комментарии можно разделить на четыре класса: объясняющие назначение программы, поясняющие смысл идентификаторов переменных и констант, описывающие логически обособленные части программы, и объясняющие сложные для понимания элементы алгоритма. В удачно прокомментированной программе легко найти ошибку, проанализировав несоответствие между замыслом автора (в комментариях) и реализацией (в тексте программы).
Ограничители < >и (* *) удобно использовать при отладке программ. В процессе отладки часто требуется временно исключить выполнение какой-либо части программы. Конечно, этого можно добиться, уничтожив временно ненужные операторы или обойдя их с помощью оператора go to. Однако оба этих способа неприемлемы по ряду причин: повторный ввод вновь понадобившихся операторов, путаница с операторами go to и т. д.
Гораздо удобнее временно ограничить ненужную часть программы символами комментария <> или (* *), тогда она будет восприниматься компилятором как комментарий и не будет исполняться.
#1 Начало программирования. Минимальная программа. Комментарии в коде. Тело программы и операторные скобки. Паскаль
Primary tabs
Forums:
Перейдём к разбору основ программирования на языке Pascal (см. наш онлайн-учебник).
Минимальная программа на языке Паскаль выглядит следующим образом:
Запустите её в вашей среде разработки программ и посмотрите что произойдёт.
Переносы строк не важны, но нужны
Дело в том, что в Паскале при выполнении других правил языка (т.н. «синтаксиса»), переносы строк не играют никакой роли, но тем не менее программу никогда не пишут в одну строчку, чтобы код был более понятным для человека (программиста).
Если говорить, более наукообразно, то можно сказать, что:
переносы строк не являются частью синтаксиса Паскаля, но используются программистами для нужд оформления программного кода и удобства его редактирования.
Комментарии к коду и в коде
Виды комментариев
Комментарий может начинаться в любом месте строки и в любой строке программы, например:
Далее вы увидите ещё много примеров использования комментариев.
Перепишем часть комментариев из предыдущего примера в многострочном стиле, например так:
— то есть в многострочных комментариях каждую строку отмечать особо не требуется.
Как было сказано выше можно закомментировать любой фрагмент, в том числе всю программу, например:
— тогда ни одной строчки выполнено не будет.
Ещё раз об отличиях и возможностях однострочных и многострочных комментариев
Также нужно понимать, что с помощью многострочных комментариев можно закомментировать только одну строку, например:
а можно и несколько строк:
С помощью однострочных можно закомментировать только одну строку (если открывающие символы стоят в начале), например:
Или только часть строки, которая начинается с открывающих однострочный комментарий символов:
Закомментировать несколько строк одним однострочным комментарием не получится (на то он и однострочный).
Зачем нужны комментарии
Комментарии нужны, чтобы:
— в теле этой программы есть одно действие.
— тело этой программы фактически пусто.
Тело программы. Операторные скобки
Далее с помощью комментариев мы будем добавлять пояснения к коду.
Таким образом очень удобно совмещать код и пояснения к нему.
Итак, поясним что такое операторные скобки и тело программы:
Также я покаже где находится тело программы с помощью комментриев:
Операторные скобки нужны, чтобы показать где именно будут описаны (с помощью Паскаля) действия программы. По сути «жизнь» кода происходит именно в окружении главных операторных скобок.