Рекомендации по оформлению текста программ

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

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

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

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

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

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

1. Используйте содержательные идентификаторы. Лучшим способом передать смысл переменной или константы является присвоение ей имени, которое отражает назначение переменной или константы. Например, если речь идет о количестве положительных чисел, то идентификатор KolPol предпочтительнее идентификаторов A, Y или еще каких-нибудь в этом духе. При выборе идентификаторов, состоящих из нескольких слов (или их частей) рекомендуется начинать их с заглавной буквы и/или разделять символом подчеркивания, например: MasSlov – массив слов; File_Exist – имя функции, определяющей наличие файла и т. д.

2. Используйте ступенчатую форму записи текста программы. Сдвиги (отступы) должны показывать каждый уровень вложенности операторов. Все программы, приведенные в этой работе, написаны именно так. Величина отступа не должна быть ни слишком малой, ни слишком большой. Можно рекомендовать отступ, равный двум символам. Все вводимые отступы запоминаются системой программирования и возврат на предыдущий уровень всегда можно осуществить нажатием клавиши " BackSpase". Не откладывайте использование ступенчатой формы " на потом". Приведение программы в надлежащий вид после ее отладки потребует больше времени или вообще не будет выполнено.

3. Пишите приглашения ясным языком. Не следует стремиться к литературным шедеврам, вполне достаточно, чтобы они однозначно понимались. Если для завершения работы с программой необходимо нажать какую-либо (или любую) клавишу, выдайте соответствующее сообщение пользователю. Вообще, никогда не оставляйте пользователя в неведении относительно того, что ему делать в каждый момент.

4. Не рекомендуется размещать несколько операторов на одной строке. В этом случае создаются искусственные трудности для чтения программы. Кроме того, такую программу труднее отлаживать.

5. При записи оператора If... Then... Else записывайте слово Else против соответствующего ему слова If. Например,

If X> 0 Then

If Y> 0 Then

Z: = Sqrt(X*X+Y*Y)

Else

Z: = X*X

Else

Z: = Y*Y;

Разобраться, что делает этот фрагмент программы намного легче по сравнению с таким его представлением:

If X> 0 Then If Y> 0 Then Z: =Sqrt(X*X+Y*Y) E lse Z: = X*X Else Z: = Y*Y;

6. Не допускайте выхода текста программы за пределы экрана (80 символов в строке). Такую программу неудобно читать, а при выводе на печать длинный оператор может быть " разрезан" принтером так, что это не будет соответствовать правилам языка программирования. Такие операторы пишите на нескольких строках, соблюдая при переносе правила Паскаля. Например, при переносе текстовой константы, запишите ее в виде нескольких констант. Идентификатор оператора рекомендуется не перекрывать строками продолжения, как это показано ниже:

 

WriteLn(' Введите 3 вещественных числа, ',

'нажимая после каждого клавишу ENTER');

ReadLn(a, b, c);

 

или

 

If ((a> b) and (c> d)) or

((KolSym < > 10) and (Dlin > nMax)) Then....

6. Используйте комментарии. Одним из способов достижения легкости понимания программы является включение в программу комментариев. Комментарии можно условно разбить на четыре класса.

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

Приводимый ниже пример поясняет сказанное.

Program Minimum;

{ Нахождение минимального элемента в массиве и его индекса }

{ Программа написана студентом 1-АИТ-9 Ивановым П.И. }

Const

Nmax = 100; { Максимальное количество элементов в массиве }

Var

A: Array[1..Nmax] Of Real; { Массив }

Min: Real; { Минимальный элемент }

Imin, { Индекс минимального элемента }

n, { Действительное количество элементов в массиве}

i: integer; { Индекс элемента массива }

Begin

Ввод исходных данных }

Writeln('Введите количество чисел');

Readln(n);

Writeln('Вводите элементы массива');

For i: = 1 To n Do

Read(X[i]);

{ Нахождение минимума }

Min: = X[1]; {За минимальный принимаем 1-ый элемент массива}

Imin: = 1; { Индекс этого элемента }

For i: = 2 To n Do {Цикл просмотра элементов массива}

If Min > X[i] Then

Begin

Min: = X[i];

Imin: = i;

End;

{ Вывод результата и завершение }

Writeln('Минимум = ', Min: 8: 2, ' Номер = ', Imin);

Writeln('Работа завершена. Нажмите клавишу ENTER');

Readln; { Ожидание нажатия на ENTER}

End.