Правила программирования

Часть 1

Введение в язык С++

Введение в практический курс

Правила программирования

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

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

2. Объявление переменной. Объявление переменной это определение ее типа и имени. Объявление переменной всегда должно предшествовать обращению к этой переменной. Если в С++ переменная не объявлена, при компиляции программы (переводе программы на язык, близкий к машинному) будет сгенерирована ошибка.

3. Инициализация переменных. После объявления переменной её рекомендуется инициализировать, т.е. присвоить ей какое-либо значение, единицу или ноль. Это очень актуально для переменных, используемых в вычислениях. Дело в том, при объявлении переменной для нее выделяется (резервируется) память. Резервирование памяти не очищает ячейки от значений, которые ранее в них хранились, поэтому, если за объявлением переменной не следует её инициализация, то текущее значение этой переменной будет непредсказуемым. При некоторых условиях компиляторы могут осуществлять очистку памяти, выделяемой под переменные.

4. Стиль записи программы. Рекомендуется придерживаться единого стиля оформления текста (интервалов, отступов, принципов записи конструкций языка, принципов именования переменных и т.д.) в пределах всей программы. Основная цель – повышение читабельности и, следовательно, понятности программы.

Пример оформления фрагмента программы без использования стилей:

void main () { cout <<”Hello, world”; getch ();};

Пример оформления фрагмента программы с использованием стилей:

void main ()

{

cout <<”Hello, world”;

getch ();

}

Некоторые рекомендации по использованию стилей:

- знаки (+ - = * /) пишутся через пробел;

- для зрительного разделения отдельных частей программы (больших фрагментов комментариев) используется штриховая линия типа:

// -----------------------------------------------------------------------------;

- скобки выравниваются вертикально по левой границе;

- включайте в программу комментарии. Они должны быть хорошо составлены, иметь правильную пунктуацию, по возможности без сокращений, и выровнены вертикально. Комментарии, в общем, воспринимаются лучше, когда помещаются в многострочных блоках, которые чередуются с блоками текста программы. Для этого комментарий должен описывать на высоком уровне, что делают несколько последующих строк кода. Не перегружайте программу комментариями – рекомендуется комментировать фрагменты программы (логически блоки кода, циклы и т.п.), а не каждый отдельный оператор. Например:

//---------------------------------

// Объявляем переменные:

// a – номер дня недели

// b – номер месяца года

// c - год

//---------------------------------

int a, b, c;

// вводим значения a, b, c

cout <<”Vvedite a – “;

cin >>a;

cout <<”Vvedite b – “;

cin >>b;