2.2.8. Текст программы

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

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

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

Короткие комментарии можно располагать в одной строке с комментируемой инструкцией (оператором) языка программирования.

Более подробные комментарии рекомендуется располагать в отдельных строках выше или ниже группы комментируемых инструкций (операторов).

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

Каждый обработчик событий должен сопровождаться достаточно подробными комментариями, поясняющими выполняемые им действия.

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

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

Переменные, константы, функции и другие именованные элементы программы, должны иметь имена, характеризующие их роль в программе.

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

Все операторы, входящие в составной оператор (BEGIN, IF, FOR, CASE и т.п.), должны быть сдвинуты вправо на 10мм.

В случае размещения оператора на двух и более строках, каждая строка переноса должна иметь смещение в 2-3 символа относительно первой строки.

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

Например:

‘************************************************************************

‘ Осуществление контекстного поиска по полю с названием рецепта в базе данных

‘************************************************************************

Private Sub поиск_товара_KeyPress(KeyAscii As Integer)

Список_товаров.Requery ‘перезапуск запроса, содержащего

источник данных

a = поиск_товара.Text ‘сохранение значения, введенного в поле

Me.Refresh ‘обновление формы

поиск_товара.Text = a ‘возврат, сохраненного значения в

поисковое поле

поиск_товара.SelStart = 256 ‘установка курсора в конец строки

поискового поля

End Sub

‘************************************************************************

‘Заполнение списка и массива NewIndex соответствующими элементами, обозначающими единицы измерения товара ‘************************************************************************

Private Sub Form_Load()

Dim NewIndex (40) as integer ‘Массив, содержащий уникальные

идентификаторы единиц измерения

With lstMeasuring

.AddItem "Рулон" ‘ввод значения в список

NewIndex(1) = 42310 ‘заполнение массива

идентификаторов

.AddItem "Метр"

NewIndex(2) = 52855

.AddItem "Штуки"

NewIndex(3) = 64932

End With

MsgBox «Массив успешно заполнен!» ‘вывод сообщения об успешно

завершенной операции

End Sub

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