DeepEdit!

Комментарии — это основной способ информирования читателя о том, каково назначение программы и как она работает. Рекомендуется распо­лагать комментарии:

В начале каждого блока и/или процедуры. В комментариях можно объ­яснить, для чего предназначен блок (процедура). Это особенно важ­но для процедур, так как в комментариях можно указать, какие параметры передаются в процедуру (входные параметры) и какие переменные или параметры возвращаются (выходные параметры). Кроме того, рекомендуется указывать объекты базы данных, к кото­рым обращается программа. В этом случае легко проследить зависи­мости процедуры.

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

например:

• Перед каждым важным разделом блока. Не нужно сопровождать коммен­тариями каждый оператор, однако весьма полезен комментарий, по­ясняющий назначение группы операторов. Используемый алгоритм можно понять по тексту программы, поэтому рекомендуется описы­вать назначение алгоритма и для чего будут использоваться резуль­таты, а не детали метода.

Может оказаться, что комментариев в программе слишком много. При принятии решения о необходимости комментария задайте себе вопрос: "О чем нужно знать программисту, видящему это в первый раз?" Учтите, что таким программистом можете стать вы сами через месяц-другой по­сле написания

Однако следующий комментарий полезен, так как в нем говорится о назначении переменной

Г]   DECLARE

Комментарий должен иметь определенный смысл и не повторять что очевидно из текста программы. К примеру, ниже приведен коммента­рий, который не сообщает ничего нового по сравнению с тем, что написа­но в программе PL/SQL, и поэтому практически бесполезен:

v Temp NUMBER := 0;     - Временная переменная, используемая в основном цикле