Комментарии

Однострочные комментарии

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

Однострочному комментарию или их группе всегда должна предшествовать пустая строка, но только в том случае, если перед ним (ней) не находится слово begin. Если комментарий относится к группе выражений, пустая строка необходима и после него. Если он относится к одному выражению, такой пустой строки быть не должно.

Пример:

// Открыть базу данных
Table1.Open;

Другой вариант расположения однострочных комментариев - на той же строке, что и код, к которому они относятся. Первым их символом также должен быть пробел. Если комментарий (группа комментариев) относится к группе выражений, необходимо выполнить выравнивание по левой границе следующим образом:

if IsEndOf(FirstStr) then   // Если встречен конец первой строки,
  Inc(SecondStrLength);     // выделить место для нуль-завершения второй

Следует избегать комментирования каждой строки кода, так как это отрицательно влияет на его читаемость.