×
COOKIES
Prezeraním tejto stránky dochádza k spracovaniu cookies. Spracovaniu cookies zabránite v nastaveniach internetového prehliadača alebo nezobrazovaním tejto stránky v internetovom prehliadači.
Technologický web Mateja Lednára
Spoznávajte svet technológií

Coding style - komentáre - časť 2

V tejto časti venovanej komentárom sa budem venovať komentovaniu programových blokov a konštánt. Pravidlo pre komentáre konštánt je možné aplikované aj na premenné pričom treba vedieť, že premenné až na výnimky by mali mať názvy zodpovedajúce uchovanej hodnote.

Konštanty a komentáre

Nie všetky konštanty musia obsahovať komentáre. Komentár pri konštante slúži na to, aby bolo zjavné, prečo má konštanta danú hodnotu. Vďaka komentáru je možné rýchlejšie zistiť, že konštante bola pridelená nesprávna hodnota.
Príklad: Konštanta s komentárom.
1
const DATE = "1.1.2011"; // dátum založenia spoločnosti

Programové bloky a komentáre

Pri rozsiahlych programových blokoch, ktoré obsahujú viacero vnorených programových blokov, je možné za znak konca bloku } uviesť komentár typu #endIF, #endWHILE, prípadne #endIF + (podmienka), #end functionName() a podobne. Tento spôsob zápisu uľahčí čítanie kódu v nástrojoch, ktoré nepodporujú folding (zbaľovanie a rozbaľovanie programových blokov) alebo formátovanie zdrojového textu.
Príklad: Komentáre na konci programových blokov.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
for (i = 10; i < 20; i++) {
if (x > 10) {
while (z < 10) {
if (y > 10) {
g = 10;
}
else if (y == 4) {
g = 4;
}
else {
z = z -2;
}
z++
} // endWHILE
a = d + g * i;
if (a == 40) {
a = a -20;
} // endIF (a == 40)
g = g * 2;
} // endIF (x > 10)
d = 40 * 24 - i;
} // endFOR
Tiež je možné skrátiť uvedené konce blokov len na názvy príkazov bez prefixu end. Príkazy je možné písať malými písmenami. Pre zvýraznenie a lepší prehľad je vhodnejšie používať veľké písmená a prípadne aj podmienku, aby bolo zjavné, ktorý blok je ukončený.
Príklad: Komentáre na konci programových blokov v podobe príkazov.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
for (i = 10; i < 20; i++) {
if (x > 10) {
while (z < 10) {
if (y > 10) {
g = 10;
}
else if (y == 4) {
g = 4;
}
else {
z = z -2;
}
z++
} // while
a = d + g * i;
if (a == 40) {
a = a -20;
} // if
g = g * 2;
} // if
d = 40 * 24 - i;
} // for
V rámci good practices sa odporúča vytvárať programové bloky čo najkratšie a najzrozumiteľnejšie. Ak by hrozilo, že programový blok má byť rozsiahly, je vhodné z vnorených blokov vytvoriť samostatné funkcie alebo metódy. Pre sprehľadnenie programových blokov sa odporúča používať odsadenie alebo vytvorené formátovanie. V takýchto prípadoch nie je potrebné dodatočne komentovať konce programových blokov.

Záver

S uvedeným spôsobom zápisu komentárov sa je možné stretnúť v jazyku PHP. V jazyku JavaScript sa tento spôsob zápisu komentárov nepoužíva. Komentovanie koncov blokov je vhodné len pre prípady, že programový kód sa bude zobrazovať v nástrojoch nepodporujúcich nastavené formátovanie (staršie konzoly a nástroje). Niektoré nástroje ponúkajú funkciu pretty print, ktorá formátuje aj nenaformátovaný zdrojový text, ak daný zdrojový kód nástroj podporuje.
Autor: Matej Lednár
Dátum: 25.1.2013
Kategória: Programovanie
Značky: programovanie, php, komentáre, javascript, coding style, good practices, bad practices
Programovanie,programovanie,PHP,komentáre,JavaScript,coding style,good practices,bad practices
Žiadna časť tohto článku nesmie byť reprodukovaná bez uvedenia autora a URL na túto stránku.
Viac informácií nájdete v sekcii O projekte.

Komentáre

Článok neobsahuje zatiaľ žiadne komentáre.

Pridať komentár

Meno (povinné)
Web
Správa (povinné)
Odoslať
Od najnovších