Komentarze są chyba najprostszym elementem każdego języka programowania. Jest to blok tekstu, który nie jest uwzględniany przez kompilator podczas budowania pliku wykonywalnego. W komentarzach można zawierać swoje przemyślenia oraz uwagi dotyczące kodu źródłowego:

program project;

begin
 { to jest komentarz }
end.

Typowy komentarz Delphi jest umieszczony pomiędzy znakami { oraz }. W edytorze kodu komentarz jest wyróżniony kursywą i kolorem zielonym (to jednak zależy od ustawień edytora kodu).

Istnieje kilka typów komentarzy, np. jednowierszowy:

// to jest komentarz jednowierszowy

Wiele osób ten rodzaj komentarzy nazywa komentarzami w stylu C, gdyż został zapożyczony z języka C. Jak sama nazwa wskazuje, komentarzem jest tylko jeden wiersz kodu źródłowego:

program project;

begin
 // tu jest komentarz,
 a tu już nie ma komentarza
end.

Drugi wiersz w bloku Begin nie jest komentarzem ? podczas kompilacji takiego kodu Delphi wskaże błąd.

Istnieje jeszcze jeden typ komentarzy ? najrzadziej używany przez programistów:

program project;

begin
  (*

    komentowany kod

  *)
end.

Zaletą tego typu komentarza jest to, że może on zawierać również znaki {.

program project;

begin
  (*

    komentarz...

    { jakiś tekst }

  *)
end.

Jak widać, taki sposób pozwala na umieszczanie komentarzy w komentarzu, ale taka możliwość jest stosunkowo rzadko wykorzystywana.

Komentarze są usuwane przez kompilator w trakcie procesu kompilacji, można więc śmiało komentować kod bez obawy, iż rozmiar pliku wykonywalnego będzie przez to większy. Jako ciekawostkę można posłużyć się tu przykładem kodu źródłowego systemu Windows 2000, który zajmuje 40 GB. Może to świadczyć o dobrze udokumentowanym kodzie. Jednak po kompilacji cały system jest oczywiście mniejszy.

Umiejętne komentowanie

Wydaje się, że pisanie komentarzy jest banalną sprawą. Chciałbym jedynie zwrócić uwagę, że nawet na samym początku nauki programowania umieszczanie własnych komentarzy w kodzie programu jest bardzo ważne. Wydawać się może, że jeżeli nie udostępniamy kodu źródłowego osobom trzecim, to komentowanie kodu staje się zbędne. Nic bardziej mylnego. Po paru miesiącach czy latach programista może mieć problemy ze zrozumieniem działania swojego własnego programu.

Chcę wyrobić w początkującym programiście pewien nawyk komentowania działania programu, gdyż nabiera to szczególnego znaczenia w pracach zespołowych, gdzie kod jest czytany przez wielu programistów ? wówczas niezwykłe znaczenie ma zrozumienie kodu napisanego przez inną osobę.

Dobrym zwyczajem jest także umieszczanie na początku każdego pliku komentarza informującego o sposobie działanie danego pliku, ewentualnie jedynie praw autorskich, daty modyfikacji itp. Przykład:

(*******************************************************)
(*               Mój pierwszy program
(*    ---------------------------------------------
(*    Copyright:           (c) by Adam Boduch
(*    Data napisania:      22.11.2003
(*    Wersja:              1.0
(*
(*******************************************************)