Pri programovaní na počítači je niekedy potrebné zanechať poznámky alebo komentáre, aby ostatní vývojári mohli ľahko prezerať váš kód. Bez ohľadu na to, či ide o projekt s otvoreným zdrojovým kódom alebo o proprietárny projekt, sú potrebné komentáre, aby bolo možné koordináciu s inými vývojármi a možnými budúcimi vývojármi. Bez komentárov by bol kód jednoducho neudržateľný.
Kroky
Krok 1. Pochopte účel pridania komentárov k počítačovému programu
- Čitateľnosť je tu kľúčová. Keď sa pozriete na komentár, mali by ste vedieť, že je to komentár, a nie riadok kódu.
- Komentár by mal byť užitočný nielen pre vás, ale pre kohokoľvek iného, kto by si mohol prečítať zdrojový kód vášho počítačového programu.
Krok 2. Vymyslite krátky a jednoduchý spôsob, ako porozumieť svojmu bodu
Komentáre nemusia byť umeleckým dielom. Mali by byť stručné, úhľadné a priamo k veci.
To by však nemalo odradiť od používania viacerých riadkov na komentovanie. Ide o to, že informácie sa musia dostať k čitateľovi
Krok 3. Napíšte komentár pomocou príslušnej syntaxe danej programovacím jazykom
Krok 4. Opýtajte sa sami seba, či je komentár, ktorý ste napísali, dostatočne podrobný
Komentár by mal byť schopný niekomu pri pohľade na zdrojový kód povedať, čo táto časť programu vlastne robí bez toho, aby ho musel skompilovať a spustiť. Dosahuje to váš komentár? Poskytuje všetky detaily?
