Как оформляются комментарии в паскаль
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 и т. д.
Гораздо удобнее временно ограничить ненужную часть программы символами комментария <> или (* *), тогда она будет восприниматься компилятором как комментарий и не будет исполняться.
Комментарии в программах на Паскале
На этом уроке мы познакомимся с очень важным инструментом Паскаля — с комментариями. Когда я говорю, что механизм этот важен, я ни на минуту не преувеличиваю. Подумайте сами, при всей жёсткости структуры программ в Паскале — при строгой привязке её кусков по месту, комментарии — единственный конструктив языка, который можно размещать где угодно, важно лишь правильно его оформить. Когда ваша программа написана, отлажена и скомпилирована, в комментариях более нет нужды, но на этапе отладки, когда вы только её пишете, а может быть, работаете в группе с другими разработчиками, комментарии будут незаменимы.
На прошлом уроке мы с вами написали первую программу «Hello, World!», сегодня мы откроем её листинг и добавим туда несколько комментариев. Урок позволит нам разобраться с тем, какие вообще бывают комментарии в Паскале, а также, мы оставим для себя самих пометки в программе, что она делает и как написана.
Откройте листинг программы HelloWorld.pas.
С какого-то момента я решил делиться написанными мной программами с вами, и для этой цели завёл репозиторий на сайте github.com. И если вы по какой-либо причине не повторяли у себя моих уроков, у вас всё же есть возможность получить доступ к листингам программ. Скачивайте их и используйте, это — бесплатно.
Итак, что же такое комментарий? Это оформленный особым образом кусок текста, который игнорируется средой разработки при исполнении и компиляции проекта, рассказывающий нам — программистам о том или ином куске программы. И раз уж PascalABC не исполняет этот кусок кода, то писать комментарии будем по-русски.
Сначала поговорим о типах комментариев. Они бывают однострочными или многострочными. Однострочный комментарий должен начинаться с двух косых чёрточек, написанных подряд без пробелов «//» и вообще говоря, не обязан начинаться с самого начала строки. Понимаю, путанное объяснение, но пока важно понять, что такой комментарий начинается с косых чёрточек и всегда заканчивается на этой же строке, какой бы длинной она не была. Следующая строка, если только она не начинается двумя слешами, интерпретируется средой разработки как строка кода.
Многострочные комментарии оформляются иначе. Здесь, очевидно, имеются как символ начала комментария, так и символ его завершения. Всё, что вы разместите между символами «(*» и «*)» или «<» и «>» компилятор будет интерпретировать как комментарий. И не важно, сколько при этом строчек в нём будет.
Перейдём к написанию комментариев. Та особенность, что однострочный комментарий может начинаться не с самого начала строки, позволяет программистам использовать их после операторов или в строчках с объявлением переменных. Мы только начали изучать Паскаль, написали лишь одну программу и всё для нас ново и непонятно. Так давайте оставим однострочные комментарии после операторов, чтобы запомнить, что они делают. Разумеется, в дальнейшем мы очень редко будем комментировать буквально каждую строку кода, но сейчас мы только учимся. В том числе, учимся оставлять комментарии.
Итак, листинг программы примет следующий вид:
Важно помнить о том, что всякий оператор Паскаля должен оканчиваться точкой с запятой. Поэтому проследите, чтобы ваши однострочные комментарии начинались уже после этого знака.
В статье на сайте это может быть не очевидно, но среда разработки — любая среда разработки, а не только PascalABC.Net — помечает комментарии цветом, который отличается от основного текста программы. Это позволит вам увидеть, где заканчиваются ваши комментарии, а где уже расположен код программы.
Теперь добавим многострочный комментарий. Их часто размещают перед самописными процедурами или функциями, а так же перед началом собственно программ. Это позволяет более развёрнуто изложить, чему посвящена процедура, функция или вся программа в целом. Теперь наш листинг выглядит так:
Не пугайтесь, именно так довольно часто оформляются многострочные комментарии в программах на Паскале. Смело используйте, изученный на этом уроке инструмент, а понимание его значимости придёт со временем.
For Informatics
Материалы к урокам информатики, алгоритмики и программирования.
Чтобы просмотреть задание и материалы с урока, выберите ваш предмет!
Главная
четверг, 2 февраля 2012 г.
Правила оформления кода на Pascal
Секции определения типов и констант Вы можете располагать относительно друг друга как Вам угодно.
Для визуального разделения элементов между ними должна быть хотя бы одна пустая строка.
СОГЛАШЕНИЕ ОБ ИМЕНОВАНИЯХ
Исключая зарезервированные слова и директивы, которые всегда пишутся в нижнем регистре, все идентификаторы Object Pascal должны использовать InfixCaps:
Правильно:
Неправильно:
Запрещается объявлять переменные с одинаковыми именами в глобальном разделе объявления переменных и в локальным разделе внутри процедур и функций.
ИСПОЛЬЗОВАНИЕ ПРОБЕЛОВ
Никогда не разрывайте строку между параметром и его типом, кроме параметров, перечисляемых через запятую. Двоеточие для всех объявлений переменных не должно содержать перед собой пробелов и иметь один пробел после перед именем типа.
Правильно
Неправильно
Нельзя переносить строки в тех местах, где не допускаются пробелы, например между именем метода и открывающей скобкой или между именем массива и открывающей квадратной скобкой. Никогда нельзя помещать выражение begin на строку, содержащую другой код.
Неправильно
Правильно
В случае с логическими операторами предпочтительнее будет следующий вариант:
КОММЕНТАРИИ
Однострочные комментарии
Однострочный комментарий состоит из символов // со следующим за ними текстом комментария. После символов // должен идти пробел и затем текст. Однострочные комментарии должны иметь отступы такие же, как и код, в котором они встречаются. Однострочные комментарии можно сгруппировать, чтобы сформировать большой комментарий.
Однострочный комментарий может начинаться с новой строки и может продолжать код, который он комментирует. В этом случае между кодом и комментарием должен быть хотя бы один пробел. Если больше одного комментария следует за кодом, то они должны быть выровнены по одному столбцу.
Пример однострочного строкового комментария:
Пример комментария в коде:
Необходимо избегать использовать комментарии в коде для каждой строки модуля.
ОПЕРАТОРЫ
Объявление локальных переменных
Локальные переменные должны иметь стиль Camel Caps. Для локальных переменных префикс F не требуется.
Все переменные с их типами, особенно поля класса, должны быть объявлены на различных строках. Объявление массивов
В объявлении массива перед и после квадратных скобок должны стоять пробелы.
Оператор if
Оператор if всегда должен располагаться по крайней мере на двух строках
Неправильно
Правильно
В случае составного оператора необходимо поместить каждый оператор на новую строку.
Неправильно
Правильно
Все остальные варианты расположения операторов не рекомендуются и не одобряются, хотя и являются синтаксически правильными. Избегайте использования круглых скобок в простых проверках. Например:
Правильно
Неправильно
Оператор for
Неправильно
Правильно
Оператор while
Неправильно
Правильно
Оператор repeat until
Правильно
Оператор case
Несмотря на то, что существует множество синтаксически правильных конструкций, одобренной и рекомендованной считается следующая:
Правильно
Const, Var и Type
Зарезервированные слова var, const и type всегда пишутся на новой строке и не допускают появления на этой же строке какого-либо текста.
Правильно
Неправильно
Процедуры должны иметь только по одной секции type, const и var в следующем порядке:
Категории и разделение алгоритмов
В секции реализации каждая подкатегория или класс должен разделяться строкой, состоящей из символов равенства (=), закомментированных однострочным комментарием и пустой строкой перед и после группы функций:
Каждая функция из одной группы или методы класса должны разделяться между собой строкой, состоящей из символов минуса (-), закомментированных однострочным комментарием и пустой строкой перед и после функции или метода:
Как оформляются комментарии в паскаль
1.1.1 чУЕ ЙДЕОФЙЖЙЛБФПТЩ ДПМЦОЩ ЧЩВЙТБФШУС ЙЪ УППВТБЦЕОЙК ЮЙФБЕНПУФЙ Й НБЛУЙНБМШОПК УЕНБОФЙЮЕУЛПК
ОБЗТХЪЛЙ.
оБРТЙНЕТ:
оЕХДБЮОЩНЙ НПЦОП УЮЙФБФШ ЙДЕОФЙЖЙЛБФПТЩ:
1.1.2. йДЕОФЙЖЙЛБФПТЩ ТЕЛПНЕОДХЕФУС РПДВЙТБФШ ЙЪ УМПЧ БОЗМЙКУЛПЗП СЪЩЛБ.
оБРТЙНЕТ:
оЕ ПЮЕОШ ХДБЮОЩНЙ НПЦОП УЮЙФБФШ ЙДЕОФЙЖЙЛБФПТЩ:
1.2.1 ъБТЕЪЕТЧЙТПЧБООЩЕ УМПЧБ СЪЩЛБ Turbo Pascal РЙУБФШ ФПМШЛП НБМЕОШЛЙНЙ ВХЛЧБНЙ.
оБРТЙНЕТ:
1.2.3 тЕЛПНЕОДХЕФУС ЙДЕОФЙЖЙЛБФПТЩ, УПУФПСЭЙЕ ЙЪ ПДОПК ВХЛЧЩ, РЙУБФШ ВПМШЫПК ВХЛЧПК, ЕУМЙ ПОЙ
ОЕ СЧМСАФУС УЮЕФЮЙЛБНЙ ГЙЛМПЧ.
оБРТЙНЕТ:
2.1.1 лПННЕОФБТЙЙ Ч ФЕМЕ РТПЗТБННЩ УМЕДХЕФ РЙУБФШ ОБ ТХУУЛПН СЪЩЛЕ Й РП УХЭЕУФЧХ ФБЛ, ЮФПВЩ РТПЗТБННЙУФ,
ОЕ ХЮБУФЧПЧБЧЫЙК Ч ТБЪТБВПФЛЕ РТПЗТБННЩ (ОП ЙНЕАЭЙК ПРЩФ ТБВПФЩ ОБ СЪЩЛЕ Turbo Pascal), НПЗ ВЕЪ
ПУПВПЗП ФТХДБ ТБЪПВТБФШУС Ч МПЗЙЛЕ РТПЗТБННЩ, Й, РТЙ ОЕПВИПДЙНПУФЙ, УПРТПЧПЦДБФШ ДБООЩК РТПЗТБННОЩК
РТПДХЛФ.
2.1.2 тЕЛПНЕОДХЕФУС ЛПННЕОФБТЙЙ РТПЗТБННЩ РЙУБФШ ЧОХФТЙ УЙНЧПМПЧ <Й >, Б (* Й *) ЙУРПМШЪПЧБФШ РТЙ ПФМБДЛЕ
РТПЗТБННЩ ЛБЛ «ЪБЗМХЫЛЙ» ХЮБУФЛПЧ РТПЗТБННОПЗП ЛПДБ.
дМС ЛБЦДПК РПМШЪПЧБФЕМШУЛПК РТПГЕДХТЩ ЙМЙ ЖХОЛГЙЙ ДПМЦОБ ВЩФШ ПРЙУБОБ Ч ЧЙДЕ ЛПННЕОФБТЙС
УРЕГЙЖЙЛБГЙС, УПДЕТЦБЭБС УМЕДХАЭХА ЙОЖПТНБГЙА:
Б) ОБЪОБЮЕОЙЕ РТПГЕДХТЩ ЙМЙ ЖХОЛГЙЙ;
В) ПРЙУБОЙЕ УЕНБОФЙЛЙ РБТБНЕФТПЧ-ЪОБЮЕОЙК (РБТБНЕФТПЧ, РЕТЕДБЧБЕНЩИ РП ЪОБЮЕОЙА), ЕУМЙ ПОБ ОЕПЮЕЧЙДОБ;
Ч) ПРЙУБОЙЕ УЕНБОФЙЛЙ РБТБНЕФТПЧ-РЕТЕНЕООЩИ (РБТБНЕФТПЧ, РЕТЕДБЧБЕНЩИ РП УУЩМЛЕ), ЕУМЙ ПОБ ОЕПЮЕЧЙДОБ.
З) ДМС ЖХОЛГЙЙ: ПРЙУБОЙЕ УЕНБОФЙЛЙ ЧПЪЧТБЭБЕНПЗП ЪОБЮЕОЙС, ЕУМЙ ПОБ ОЕПЮЕЧЙДОБ.
оБРТЙНЕТ:
ъБНЕЮБОЙЕ:
еУМЙ РТПГЕДХТБ (ЖХОЛГЙС) ТЕБМЙЪХЕФ ЛБЛПК-МЙВП ЧЩЮЙУМЙФЕМШОЩК НЕФПД (ОБРТЙНЕТ: ОБИПЦДЕОЙЕ РМПЭБДЙ
ЖЙЗХТЩ НЕФПДПН ФТБРЕГЙК, РПЙУЛ НЙОЙНХНБ ЖХОЛГЙЙ НЕФПДПН оШАФПОБ Й Ф.Р.), ТЕЛПНЕОДХЕФУС Ч ФЕМЕ
РТПГЕДХТЩ (ЖХОЛГЙЙ) РПНЕУФЙФШ ЛПННЕОФБТЙК У ЛТБФЛЙН ПРЙУБОЙЕН НЕФПДБ, МЙВП УУЩМЛХ ОБ ЙУФПЮОЙЛ, ЗДЕ
ПРЙУБО НЕФПД.
дМЙОБ УФТПЛ РТПЗТБННЩ ОЕ ДПМЦОБ РТЕЧЩЫБФШ ЫЙТЙОЩ ЬЛТБОБ (80 УЙНЧПМПЧ).
3.3.1 тЕЛПНЕОДХЕФУС ПРЕТБОДЩ ВЙОБТОЩИ ПРЕТБГЙК (+, := Й Ф.Р.) ПФДЕМСФШ ПФ ЪОБЛБ ПРЕТБГЙЙ ПДОЙН РТПВЕМПН » «.
оБРТЙНЕТ:
3.3.2 тЕЛПНЕОДХЕФУС РТЙ РЕТЕЮЙУМЕОЙЙ ЙДЕОФЙЖЙЛБФПТПЧ РПУМЕ ЪБРСФПК «,» УФБЧЙФШ ПДЙО РТПВЕМ » «.
оБРТЙНЕТ:
3.3.3 тЕЛПНЕОДХЕФУС ЧУЕЗДБ РЙУБФШ УЙНЧПМ-ТБЪДЕМЙФЕМШ ПРЕТБФПТПЧ «;» (УТБЪХ ЦЕ РПУМЕ ПРЕТБФПТБ).
оБРТЙНЕТ:
3.3.4 тЕЛПНЕОДХЕФУС РПУМЕ УЙНЧПМБ-УРЕГЙЖЙЛБФПТБ ФЙРБ «:» УФБЧЙФШ ПДЙО РТПВЕМ » «.
оБРТЙНЕТ:
3.3.5 тЕЛПНЕОДХЕФУС 16-ТЙЮОЩЕ ЮЙУМБ РЙУБФШ ВПМШЫЙНЙ ВХЛЧБНЙ.
оБРТЙНЕТ: