Komentáre urobia program prehľadný

Z Delphi & Pascal (česká wiki)
Přejít na: navigace, hledání

Prehľadný program - správne odsadzujte riadky

Je dobré si zvyknúť že nie všetky riadky programu začínajú úplne vľavo. Pýtate sa prečo je to dôležité? Je to kvôli čitateľnosti programu. Je dobré ak pri pohľade na program okamžite vidím kde začína alebo končí procedúra ktoré príkazy patria ktorému cyklu či podmienke.


Téme ako odsadzovať je venovaných mnoho článkov. Ja ukážem ako správne odsadenie programu program sprehľadní a urobí ho čitateľnejším.


Uvediem príklad programu ktorý nieje odsadení vôbec

procedure vynulujmlade;
begin
for i:= 1 to 10 do begin
for j:= 1 to 10 do begin
if kvet[i,j]=1 then kvet[i,j]:=2;
end;
end;
end;
procedure vykresli;
begin
clrscr;
for i:= 1 to 10 do begin
for j:= 1 to 10 do begin
if kvet[i,j]=0 then
begin
textcolor(darkgray);
gotoxy(i*4,j*2);Write('x');
end;
if kvet[i,j]=2 then
begin
textcolor(green);
gotoxy(i*4,j*2);Write('O');
end;
end;
end;
end;

Hrôza že? Tak teraz ten istý program ale s odsadením

{ Vynuluje mlade rastlinky }
procedure VynulujMlade;
var i,j:integer;
begin
 for i:= 1 to 10 do
  for j:= 1 to 10 do
   if kvet[i,j]=1 then kvet[i,j]:=2;
end;
 
 
{ semigraficke zobrazenie stavu rastliniek }
procedure Vykresli;
var i,j:integer;
begin
 clrscr;
 for i:= 1 to 10 do begin
  for j:= 1 to 10 do begin
   if kvet[i,j]=0 then
   begin
     textcolor(darkgray);
     gotoxy(i*4,j*2);Write('x');
   end;

   if kvet[i,j]=2 then
   begin
     textcolor(green);
     gotoxy(i*4,j*2);Write('O');
   end; {if}
  end; {for j}
 end; {for i}
end;


A teraz pár zásad
  • Pred každú časť programu napíšte krátky komentár. Komentár píšte pred každou funkciou a procedúrou. Taktiež každý dôležitý úsek programu okomentujte. Prečo je to dobré? Komentár má byť pomôckou a vysvetlením vaších myšlienok. Nezanedbávajte ho.
  • Odsadzujte riadky cyklu (podmienky, procedúry a pod.) tak aby bolo okamžite jasné že patria danému cyklu. Presne tak ako to vidíte v príklade.
  • Nebojte sa dávať prázdne riadky na oddelenie celku. Aj v normálnom texte sa dávajú odstavce, robte ich aj v programe. Mne sa osvedčilo pred procedúru dať 2 prázdne riadky, kometár a potom začne samotná procedúra. Ak je dlhší cyklus alebo podmienka taktež dávam prázdny riadok.
  • Možno si nájdete vlastný štýl a možno bude lepší ... Ale dovtedy si osvojte aspoň týchto pár zásad aby boli vaše programy čitateľné a prehľadné nielen vám, ale aj tým čo prídu po vás.


Zdeno Sekerák (diskusia)