Spisu treści:
Definicja - Co oznacza komentarz?
Komentarz to specjalna konstrukcja w języku programowania, która pozwala twórcy programu wspomnieć o dodatkowych informacjach związanych z programem. Głównym powodem umieszczania komentarzy w językach programowania jest poprawa przenośności i łatwości konserwacji kodu.
Techopedia wyjaśnia komentarz
Często zespoły programistów pracują razem nad różnymi modułami oprogramowania, które są sprawdzane przez inżynierów testujących podczas procesu testowania. Podczas procesu testowania inżynierowie muszą być świadomi działania modułu. Dlatego twórca zamieszcza komentarze w celu wyjaśnienia działania konkretnego modułu, podając prawidłowe typy danych wejściowych, liczbę danych wejściowych, algorytm wykorzystywany do przetwarzania w module wewnętrznym, oczekiwane wyniki i warunki błędów, które mogą wystąpić podczas przetwarzania.
Komentarze często zawierają również informacje dotyczące autora treści, daty i godziny jej opracowania oraz daty i godziny ostatniej modyfikacji. Ile szczegółów należy podać, to kwestia subiektywności. Niektórzy programiści znani są z nienawiści do komentarzy i postrzegają je jako stratę czasu. Dla innych komentarze są absolutną koniecznością. Teoretycznie organizacja powinna ustanowić wszystkie standardy kodowania. Jednak z jakiegokolwiek powodu każdy, kto odziedziczył kod z poprzedniego zespołu programistów, powie Ci więcej razy, że kod nie zawiera komentarzy, które chcieliby zobaczyć.
