Комментирование кода
Все изменения в коде должны сопровождаться меткой разработчика.
Шаблон для комментирования кода :
// <?"",ДатаВремя,"ДФ=дд.ММ.yyyy"> *** ЦПР *** <Фамилия> Проект "<Имя проекта>" Задача No <?"Укажите
номер задачи"> (начало)
// комментарий к фрагменту кода
Изменяемый код
// <?"",ДатаВремя,"ДФ=дд.ММ.yyyy"> *** ЦПР *** <Фамилия> Проект "<Имя проекта>" Задача No <?"Укажите
номер задачи"> (окончание)
где
- <ДатаВремя> - дата внесения изменений; ДатаВремя>
- <Фамилия> - фамилия разработчика; Фамилия>
- <Имя проекта=""> - номер выполняемой задачи (в большинстве случаев номер проектного решения); Имя>
Для изменения кода указание комментария в конце строки не допускается.
Комментарий к фрагменту кода должен кратко описывать, для чего вносились изменения, а также, при необходимости, давать пояснения другим разработчикам об алгоритме работы фрагмента.