Текст программы оформляется в соответствии с требованиями ГОСТ 19.401-78 [7], которые достаточно просты и естественны. Главное, чем требуется руководствоваться при создании этого документа – это удобочитаемость текста программы.
Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования. Текст каждого программного файла начинается с "шапки", в которой указывается:
– наименование программы;
– автор;
– дата создания программы;
– номер версии;
– дата последней модификации.
В тексте
программы обязательным является использование комментариев (отражающих
структуру программы и функциональное назначение отдельных ее фрагментов), а
также строгое соблюдение правил отступа (структуризации). Комментарии должны быть
наглядны и легко отличимы от операторов программы. Помните, оправдать можно
даже неумение создавать программную документацию, а некрасивый текст программы
– никогда. Ссылки на то, что этот текст понятен самому автору, всерьез не
воспринимаются. Тексты программ должно быть
не стыдно давать читать другим людям.
Пример.
{-- Сортировка элементов массива по возрастанию их
значений --}
Procedure
SortArray(n : Integer; Var NQ : Array[1..n] of Real);
Var k :
Real; {Служебная переменная}
i,j :
Integer; {Переменные циклов}
Begin
for i:=1 to n-1 do
for j:=i+1 to n do
if NQ[j]<NQ[i] then
begin
{обмен значениями элементов массива}
k:=NQ[j];
NQ[j]:=NQ[i];
NQ[i]:=k
end
End;