Treść książki
Przejdź do opcji czytnikaPrzejdź do nawigacjiPrzejdź do informacjiPrzejdź do stopki
Stylprogramowaniaiwłasnościprogramów
13
Komentarze
Wróżnychjęzykachstosujesięodmiennekonwencjepisaniakomentarzy.WFor-
traniespecjalnysymbol(literaC)wpierwszejkolumniezapowiada,żewierszjestko-
mentarzem.Słabympunktemtejkonwencjijestniemożliwośćpisaniakomentarzywtym
samymwierszu,coinstrukcja.WjęzykuAlgolkomentarzrozpoczynasymbolcomment,
akończygośrednik.WPascalukomentarzumieszczasięmiędzydwomanawiasami
klamrowymi{},dlategotakiekomentarzemożnapisaćwśrodkuinstrukcji,np.
ifBAs( nil{listajestpusta}then...
Zmianawierszanieoznaczatutajkońcakomentarza,natomiastpominięciesymbolu
końcakomentarzamożeoznaczać,żedużyfragmentprogramustaniesięczęściąkomenta-
rza(ażdonapotkaniaznaku}zamykającegokomentarz).Jesttogłównyzarzutstawiany
tejmetodzie.WadytejniemakomentarzwjęzykuAda,któryrozpoczynasięwyróżnio-
nymsymbolem(podwójnymmyślnikiem)ikończyzmianąwiersza,orazwjęzykuC
iC++gdzierozpoczynasięodznaków//.DodatkowowjęzykuCorazC++możnauży-
waćkomentarzymiędzyogranicznikami/*i*/.
Komentarzemogąbyćwstępnelubobjaśniające.Komentarzwstępnyumieszczasię
napoczątkuprogramu.Powinienonzawieraćnp.:
ñ
nazwiskoautora,datęnapisania,
ñ
sposóbużycia,informacjeoczasiedziałania,wymaganejpamięcioperacyjnej,spe-
cjalnepoleceniadlaoperatora,
ñ
listęiopisważniejszychzmiennych,wykaztablic,strukturdanych,listęwszystkich
plików,
ñ
pouczenieowe/wy,
ñ
listęużywanychiwywoływanychprogramów,
ñ
nazwyużytychspecjalnychmetodiuwagi.
Komentarzobjaśniającyumieszczasięwceluobjaśnieniakażdegofragmentupro-
gramu,któregosensniemusibyćoczywistypodczaslekturykodu.Należyjerównież
umieszczaćprzedważniejszymipętlamilubskokami,wskazując,cojestwłaściwiewyko-
nywane.Wartoprzyjąćjakozasadęumieszczanieconajmniejjednegokomentarzado
każdych10wierszytekstuprogramuwjęzykuwysokiegopoziomu.Należypamiętać,że
mnogośćkomentarzyalboichtrywialnośćmożeprzeszkadzaćczytelnikowi,odwracając
jegouwagęodkodu.Jednakbardzonieliczneprogramyużytkowesąprzesadnieskomen-
towane.
Językiwysokiegopoziomuzostałyzaprojektowanetak,abyprogramybyłyjaknaj-
bardziejczytelneisamodokumentującesię,częstojednakstrukturaprzyjętaprzezprogra-
mistęjestzłożonaiprogramjestniejasnydlakogoś,ktogoczyta.Wtedyrodzajużytego
komentarzamadużeznaczenie.Należyprzyjąć,żeczytelnikznajęzyk,wktórymnapisa-
noprogram,ztegowzględukomentarzepowinnywyjaśniaćprzeznaczeniegrupyinstruk-
