Комментарии

Lazarus IDE: Основы программирования в Windows Несмотря на то, что всё потихоньку уходит в сеть, программирование для настольных компьютеров остаётся востребованным. И будет таковым ещё долго. Ну а самая распространённая операционная система для настольных компьютеров – это по-прежнему Windows. Поэтому любой программист, даже если он собирается стать веб-разработчиком, должен знать хотя бы основы создания программ для Windows. Подробнее...

Вы наверняка уже знаете, что такое комментарии. Но, быть может, знаете об этом вы ещё не всё.

Зачем нужны комментарии?

Во-первых, в начале каждого модуля или программы программист обычно указывает автора, версию, дату создания и т.п.

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

В-третьих, есть сложные алгоритмы, разобраться в которых без комментариев трудно не только другому человеку, но и самому автору через пару недель, а тем более лет.

Комментарии Free Pascal могут быть такими:

{Это комментарий в фигурных скобках}
(* И это тоже комментарий, но уже в круглых скобках со звёздочками *)
// А это комментарий в стиле С++

Как видите, Free Pascal поддерживает несколько видов комментариев. Последний пример – это комментарии в стиле С++ (в обычном Паскале такие комментарии не предусмотрены).

Комментарий в стиле С++ начинается двумя косыми чертами и продолжается до конца строки. То есть комментарии Паскаля открываются и закрываются скобками, а комментарий в стиле С++ открывается двумя косыми чертами и действует до конца строки. А это значит, что если вы используете комментарии в стиле С++, то в начале каждой строки с комментарием вам нужно ставить две косые черты.

В каком стиле писать комментарии – это личное дело каждого. Однако лучше привыкать писать их с первых шагов в изучении программирования. Очень часто бывает, что приходится отложить работу над программой на какой то срок, либо адаптировать старую программу к новым условиям. Вернувшись к своей программе через месяц, вы уже вряд ли будете помнить ход своих мыслей в момент работы над программой, и придётся заново разбираться с исходными кодами. В некоторых случаях бывает проще написать новую программу, чем разбираться с исходными кодами старой (особенно если она плохо документирована).

Что ещё нужно знать о комментариях?

Комментарии могут быть вложенными. Например,

{ Это комментарий, в который
  (* вложен другой *)
  комментарий
}

Как видите, вложенный комментарий ничем не отличается от обычного комментария, за исключением того, что он находится внутри другого комментария

В классических компиляторах Паскаля (например, в Turbo Pascal и Delphi), тип вложенных комментариев ОБЯЗАТЕЛЬНО должен отличаться от типа комментария, в который вложен комментарий.

То есть такой комментарий

{ Это комментарий, в который
  { вложен другой }
  комментарий
}

Вызовет ошибку во время компиляции.

Free Pascal допускает вложенные комментарии одинакового типа. Хотя при компиляции в таком случае будет выдано предупреждение. Однако не следует этим злоупотреблять, так как это плохо скажется на переносимости кода.

Кроме комментариев в фигурных скобках также могут быть директивы компилятора. Выглядят они примерно так:

{$mode objfpc}{$H+}

То есть директива компилятора начинается со знака доллара. Поэтому никогда не начинайте свои комментарии со знака доллара. Это может привести к проблемам.

О директивах компилятора мы пока можем забыть. Для начинающих это лишняя информация. Если кому интересно - читайте документацию.

Ну и напоследок привожу текст программы с разными видами комментариев.

program comment;

{$mode objfpc}{$H+}                   //Это директива компилятора

uses
  {$IFDEF UNIX}{$IFDEF UseCThreads}   //Это тоже директива
  cthreads,
  {$ENDIF}{$ENDIF}                    //Это тоже директива
  Classes
  { you can add units after this };   //Это комментарий

begin
  //Это однострочный комментарий
  { Этот комментарий
    может занимать
    несколько строк}
  (* Это тоже многострочный
     комментарий *)
  { А вот так { делать нельзя в режиме Turbo Pascal
                и Delphi}
    потому что вложенные комментарии
    могут быть только разных видов }
  { Правильный (* Вложенный
    комментарий *) лучше делать так }
end.