Важной составляющей хорошей программы PL/SQL является встроенная документация - комментарии. Даже если вы используете в своих PL/SQL- программах удобную модульную структуру и «говорящие» названия,
этого обычно бывает недостаточно для того, чтобы обеспечить полное понимание сложной программы.
PL/SQL поддерживает два вида комментариев: однострочные и многострочные.
Синтаксис однострочного комментария
Однострочный комментарий начинается двумя дефисами (--), между которыми не может стоять пробел или какой-либо другой символ. Весь текст после двойного дефиса и до физического конца строки воспринимается как комментарий и игнорируется компилятором. Если двойной дефис стоит в начале строки, то вся строка является комментарием.
В следующем операторе IF для пояснения его логики использован однострочный комментарий:
IF salary < min_salary (2003) --Функция возвращает минимал.годовую зарплату.
THEN salary := salary + salary*.25; END IF;
Синтаксис многострочного комментария
Однострочные комментарии удобны для создания кратких пояснений к фрагментам кода или для временного исключения строки программы из исполнения, тогда как многострочные комментарии позволяют включать в программу длинные поясняющие тексты.
Многострочные комментарии начинаются после символов «косая черта-звездочка» (/*) и заканчиваются символами «звездочка-косая черта» (*/). Весь текст, находящийся между этими двумя последовательностями символов, PL/SQL воспринимает как комментарий, и компилятор его игнорирует.
Рассмотрим в качестве примера многострочного комментария блок текста в заголовке процедуры. Символы вертикальной черты в левой части строк использованы для того, чтобы заострить внимание читателя на комментарии:
PROCEDURE calc_revenue (company_id IN NUMBER) /* | Программа: calc_revenue | Автор: Василь Пупкин */ IS