Strona 1

[lekcja] Komentarze | Kurs C++ » Poziom 1

2011-11-12 15:27:01

http://cpp0x.pl/kursy/Kurs-C++/Poziom-1/Komentarze/8

Darmowe kursy Online

»

Kurs C++

»

Poziom 1

Autor: Piotr Szawdyński

Komentarze

[lekcja]

Rozdział 5. Komentarze- forma zapisu oraz wskazówki jak z nich prawidłowo korzystać.

Kolejną (ale niezbyt fascynującą) rzeczą, którą trzeba omówić są komentarze. Żeby nie zanudzać o czymś, co nie ma żadnego znaczenia

z punktu widzenia kompilatora przejdę od razu do rzeczy.

Co to jest komentarz?

Komentarz jest to notatka sporządzona przez programistę, znajdująca się w kodzie źródłowym programu. Komentarz w żaden sposób nie

wpływa na działanie programu.

Komentarzew C/C++

W językach C i C++ mamy do dyspozycji trzy rodzaje komentarzy:

komentarz jednowierszowy ;
komentarz wielowierszowy ;
komentarz wykonany za pomocą dyrektyw preprocesora .

Tym ostatnim nie będziemy się zajmowali na razie ze względu na to, iż przez początkowego programistę były by one niewłaściwie

używane.

Komentarz jednowierszowy

Komentarz jednowierszowy rozpoczyna się od znaków // i trwa on od miejsca wystąpienia tych znaków do końca wiersza. Od niniejszej

reguły istnieją wyjątki - jeden z nich przedstawia poniższy przykład:

C/C++

#include <cstdio>

//To jest dyrektywa

int

main

()

{

//To jest jaki

ś

komentarz dla bajeru

printf

(

"Test dzialania Code::Blocks // to jest dalej tekst"

)

;

//a to komentarz

return

0

;

}

Jak widać w powyższym przykładzie komentarzem nie stanie się tekst zawarty w podwójnych apostrofach. Jest to oczywiście pożądane

działanie. Myślę, że przykład jest na tyle wymowny, że można przejść dalej.

Komentarzewielowierszowe

Komentarz wielowierszowy rozpoczyna się znakami /* i kończy się znakami */. Dłuższy wywód na niewiele się zda, więc przejdźmy po

raz kolejny do przykładu:

C/C++

#include <cstdio>

/*komentarz

trwa...

tak wygl

ą

da koniec:*/

int

/*tu te

ż

mo

ż

na wcisn

ąć

komentarz*/

main

()

{

printf

(

"Test dzialania /* to jest tekst */ Code::Blocks"

)

;

/* a to komentarz

który trwa... */

return

0

;

}

Generalnie zaleca się stosować komentarze jednowierszowe , gdy dodajemy jakieś opisy działania programu. Komentarz wielowierszowy

przydaje się często gdy chcemy wymienić jakiś stary algorytm na nowy, np. wersję źle działającą algorytmu komentujemy i w miejsce

starego kodu piszemy nową, jednocześnie mając wgląd na to co wcześniej napisaliśmy.

Kiedy stosować komentarze

Póki jesteś początkowym programistą stosowanie komentarzy ma sens do opisywania nowych funkcji używanych w programie. Być może

ułatwi Ci to utrwalenie wiadomości. Wraz ze zwiększeniem swojej wiedzy i umiejętności programistycznych możesz mieć wrażenie, że

komentarze zaczną być jednak zbędne. Faktem jest, że programiści z większym doświadczeniem bardzo skromnie komentują kod (albo

wcale tego nie robią). Nie wynika to jednak z tego, że nie ma co tam napisać, tylko zazwyczaj zmienne i funkcje są na tyle wymowne,

że opisują co dany fragment kodu robi. Czasami jednak gdy będziesz pisał dłuższy kod warto wstawić komentarze jednowierszowe

Strona 2

[lekcja] Komentarze | Kurs C++ » Poziom 1

2011-11-12 15:27:01

http://cpp0x.pl/kursy/Kurs-C++/Poziom-1/Komentarze/8

Architektserwisu: Piotr Szawdyński

© Wszelkieprawa zastrzeżone2005-2011

//... tutaj kod wczytuj

ą

cy dane

//Sortowanie danych

//... tutaj kod sortuj

ą

cy dane

//Wypisanie danych

//... tutaj kod wypisuj

ą

cy dane

Wracając do tak udokumentowanego kodu po kilku miesiącach nie będziesz musiał analizować całego kodu tylko fragmenty, które Ciebie

interesują. Ułatwia to również późniejsze wyszukiwanie ewentualnych błędów np. w przypadku gdy dane poprawnie są wczytywane i

poprawnie wypisywane, ale są posortowane w złej kolejności.

Wszystkieteksty są chronioneprawami autorskimi. Kopiowanielub rozpowszechnianietreści poza niniejszymserwisem jest

zabronione.

Powyższe ograniczenie nie dotyczy autora opracowania, któremu przysługuje prawo do rozpowszechnianiawłasnego tekstu wedle własnego uznania.