24.Правила составления комментариев в исходных текстах программ.

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

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

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

Некоторые основные правила составления комментариев:

1) Комментарии должны быть достаточно подробными и понятными для чтения другим специалистам.

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

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

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

5) Каждая глобальная переменная должна иметь комментарий.

6) Каждый модуль должен иметь комментарий.

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

В комментариях необходимо использовать некоторые комбинации символов для функционального разделения комментариев.

Например:

1) Выделение подпрограммы

//*****************Название процедуры****************

//******************Конец процедуры с конкретным названием*****

2) Изменения при внедрении.

//@нZerg010203№567

Начало изменения исходного текста выполненного программистом с ником Zerg 1 февраля 2003 года описанного в реестре изменений по номером 567.

//@ кZerg010203№567

конец изменения

3) Комментарий к специфическому алгоритму под номером 134 в описании программы.

//=134 Алгоритм декульзирования:

// Необходимо для ……

4) Глобальная переменная

Var Scanner1:Variant; {Переменная через которую обращаемся к сканеру штрих-кодов}

5) Информация о программисте выполнившем изменения.

//i_Zerg – Карганов Олег Петрович , OOO «Софт-Сибирь» тел:.44-33-55

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

25.Инфраструктура проектируемой ис - назначение, состав, методы согласования.

26.Внедрение и сопровождение ис. Состав работ и условия взаимодействия с клиентом.

27.Перечень работ руководителя проекта при управлении созданием новой ис.