Стиль оформления программы

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

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

Стиль оформления программы включает:

• правила именования объектов программы (переменных, функций, ти­пов, данных и т. п.);

• правила оформления модулей;

• стиль оформления текстов модулей.

Правила именования объектов программы. При выборе имен про­граммных объектов следует придерживаться следующих правил:

• имя объекта должно соответствовать его содержанию, например:

Maxltem - максимальный элемент;

Nextltem - следующий элемент;

• если позволяет язык программирования, можно использовать символ
«» для визуального разделения имен, состоящих из нескольких слов, например:

Maxjtem, Next_Item;

• необходимо избегать близких по написанию имен, например:

Index и InDec.

Правила оформления модулей. Каждый модуль должен предваряться заголовком, который, как минимум, содержит:

• название модуля;

• краткое описание его назначения;

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

• список используемых (вызываемых) модулей;

• краткое описание алгоритма (метода) и/или ограничений;

• ФИО автора программы;

• идентифицирующую информацию (номер версии и/или дату послед­
ней корректировки). Например:

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

Для таких языков, как Pascal, C++ и Java, использование отступов поз­воляет прояснить структуру программы: Обычно дополнительный отступ обозначает вложение операторов языка, например:

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

Дата добавления: 2014-01-07