1.12. Комментарии. Использование пробелов

По мере усложнения ваших программ количество содержащихся в них операторов может сделать программы слишком трудными для понимания. Поскольку другим программистам может потребоваться понять и, возможно, изменить ваши программы, вам следует делать программы более удобочитаемыми. Способы улучшения удобочитаемости программ включают:

• использование понятных по смыслу имен переменных, описывающих их применение;

• использование подходящих отступов и выравнивания;

• использование пустых строк для разделения несвязанных операторов;

• использование комментариев, которые объясняют работу программы;

• использование пробелов.

В текст программы на языке С++ разрешается вставлять комментарии и про­белы. Комментарии и пробелы, как правило, используется программистом для повышения наглядности текста программы и для упрощения в работе с программой.

Пробелы достаточно широко используются при написании прог­раммы на языке С++. Они могут ставиться по оба стороны от знаков опе­раций и большинства ограничителей. Пробелы должны отделять стоящие ря­дом ключевые слова, идентификаторы, константы. При этом там, где может использоваться один пробел, разрешается устанавливать любое количест­во пробелов.

Пробелы могут быть использованы в различных местах программы с целью облегчить чтение составленной программы при дальнейшей работе с нею. В частности, пробелами удобно выделять знаки операций в выра­жениях .

Пример:

В+С эквивалентно В + С или В + С

(А+В) эквивалентно ( А + В )

В ряде случаев полезно использовать целые строчки текста программы, состоящие их одних пробелов, для разделения текста программы на смыс­ловые части.

Пробелы допускаются также внутри констант типа строки символов.

Вместе с тем, запрещено использование пробелов внутри идентифика­торов, констант, спецификаций шаблоном, составных символов операций (составными символами в языке С++ называют следующие пары символов:

++ -- >> <<

Комментарии предназначены для пояснения назначения переменных и действий программы. Комментарий является частью кода, который игнорируется компилятором.

Существует два способа вставки комментариев в программу:

1. Опасный с помощью открывающей скобки комментария "/*" и закрывающей скобки комментария "*/". Текст, который находится между парой таких скобок, является комментарием. Общий формат комментария представляет собой:

/* ТЕКСТ*/,

где ТЕКСТ – последовательность любых символов алфавита языка С++, а также букв русского алфавита.

Оформленный таким образом комментарий может занимать более одной строки.

/*Пример программы на языке Си*/

2. Безопасный с помощью пары символов "//". Текст, записанный после данной пары символов до конца строки является комментарием. С помощью этого способа можно вставлять только однострочные комментарии.

// директива препроцессора

Комментарии могут быть записаны в любом месте программы, где можно поставить пробел, но только не внутри константы типа строки символов.

В частности, комментарии могут помещаться после любого оператора, перед началом программы и после нее, на отдельной строчке текста про­граммы.

Примеры комментариев;

СХ: /* ВЫЧИСЛЕНИЕ СОПРОТИВЛЕНИЯ */

/* ОСТАНОВ ПРИ X < 0 */

} /* КОНЕЦ ПРОГРАММЫ*/

А2 = М + /*Производится сложение двух переменных*/ В;

Пары символов /* и */ должны быть написаны слитно, и пара */ не должна встречаться в середине комментария.

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

Комментарии используются для пояснения и документирования (повыше­ния читабельности) программы, отделения одной части программы от дру­гой и описания их содержания, для пояснения используемых в программе величин.

Комментарии игнорируются транслятором и поэтому не оказывают ника­кого влияния на выполнение программы (на решение задачи), но они вос­производятся в листинге (распечатке) программы и, следовательно, помо­гают программисту ориентироваться в ее тексте.

У начинающих программистов часто возникают проблемы, связанные с тем, что и когда комментировать.

Как правило, следует вкючать немного комментариев в ваши программы. Поэтому убедитесь, что они полезны. Следующие комментарии не дают дополнительной информации программистам, читающим код:

age =32; // Присвоить 32 переменной age

salary = 25000.75; // Присвоить 25000.75 переменной salary

Цель использования комментариев заключается в том, чтобы объяснить работу программы.

Замечание: В дополнение к использованию комментариев для улучшения удобочитаемости своей программы вам следует использовать пустые строки для разделения несвязанных операторов. Когда компилятор C++ встречает пустую строку, он просто пропускает эту строку.

Комментарии не увеличива­ют размер исполняемой программы, поскольку компилятор их игнорирует.

В программах обычно используются обе формы комментариев. Парные коммен­тарии, как правило, используют для многострочных объяснений, а двойную на­клонную черту — для замечаний в той же строке, что и код.

Слишком длинные комментарии могут ухудшить читабельность кода. Обычно блок комментариев помещают выше кода, к которому он относится.

По мере изменения кода комментарии следует обновлять. Программисты пола­гают, что комментарии правдивы, и верят им, даже если остальная документация свидетельствует об ином. Некорректный комментарий хуже отсутствия коммента­рия, поскольку он может ввести читателя в заблуждение.

Парный комментарий не допускает вложения. Комментарий, который начинается символом /*, всегда завершается следую­щим символом */. Поэтому один парный комментарий не может находиться внут­ри другого. Сообщение о подобной ошибке, выданное компилятором, как прави­ло, вызывает удивление.