Как птицу видно по полёту, так и хорошего программиста - по комментариям в программе. Их должно быть много, но они должны описывать алгоритм, а не элементарные действия, которые и без того всем понятны.
Например, комментарий
ничего не объясняет, а просто пересказывает действие оператора сложения.
Комментарий
с:= с+1; // увеличиваем значение счётчика слов
уже значительно лучше, поскольку мы понимаем, что в этом месте кода подсчитывается количество слов, а не абстрактных объектов.
Когда вы только пишете программу, вам и без комментариев всё в ней понятно. Но если вам понадобится модифицировать программу, написанную несколько месяцев назад, вот тогда и начнутся проблемы: без комментариев придётся восстанавливать весь алгоритм заново, а это иногда бывает труднее, чем с начала придумать новый.
Не меньше трудностей вы создадите и своим друзьям-товарищам, если поделитесь с ними своей программой. Вряд ли им доставит удовольствие многочасовой разбор «немого» кода. Ещё больше вы сможете насолить им и себе, если будете называть объекты малопонятными именами.
Вывод такой: не жалейте времени на комментирование программы. Вам и самому будет легко разобраться в коде и другие программисты будут вспоминать вас с благодарностью всю оставшуюся жизнь.
А вот транслятору ваши комментарии ни к чему, он просто игнорирует их при компиляции программы, так что от ваших пояснений выполняемый код не увеличится ни на один байт.
Обычно комментарии занимают целиком всю строку либо остаток строки:
// увеличиваем значение счётчика слов с:= с+1; с:= с+1; // увеличиваем значение счётчика слов
В этом случае они начинаются двумя слешами, за которыми и следует собственно комментарий. В самом комментарии разрешается использовать любые символы.
Реже комментарии располагают внутри кода (в любом его месте), тогда они обрамляется фигурными скобками:
Вместо фигурных скобок можно использовать круглые скобки со звёздочками:
Второй способ можно применять и для комментариев внутри комментариев, записанных с помощью фигурных скобок:
// увеличиваем значение счётчика слов с:= с+1;
с:= с+1; // увеличиваем значение счётчика слов
с:= {увеличиваем значение счётчика слов}
с+1; с:= (* увеличиваем значение счётчика слов *)
с+1;
}
Если вам при отладке программы понадобится закомментировать блок кода, то достаточно заключить его в фигурные скобки. С одностррчными комментариями всё будет нормально, но комментарии с фигурными скобками будут вызывать коллизии. Обратите внимание на третью строку кода: закрывающая фигурная скобка завершает комментарий, и весь следующий код оказывается раскомментированным, что приведёт к ошибке, как только компилятор наткнётся на вторую закрывающую фигурную скобку.