oknosoft / checkdata

Проверка данных
MIT License
2 stars 0 forks source link

Заголовки процедур и функций #82

Closed nmivan closed 5 years ago

nmivan commented 6 years ago

4.6. Все процедуры и функции должны предваряться заголовком Заголовок имеет цель пояснить назначение и использование функции (процедуры) и размещается перед ее объявлением. Заголовок должен иметь следующий формат:

секция "Описание" - содержит краткое описание назначения и/или принципов работы процедуры(функции), может быть единственной секцией для функций без параметров; секция "Параметры" - описывает параметры процедуры(функции), если их нет, секция пропускается, предваряется строкой "Параметры:"; секция "Возвращаемое значение" - описывает тип и содержание возвращаемого значения функции, предваряется строкой "Возвращаемое значение:", для процедур эта секция отсутствует.