Při programování na počítači je někdy nutné zanechat poznámky nebo komentáře, aby ostatní vývojáři mohli snadno procházet váš kód. Ať už se jedná o projekt s otevřeným zdrojovým kódem nebo o proprietární projekt, ke koordinaci se spoluvývojáři a případnými budoucími vývojáři jsou zapotřebí komentáře. Bez komentářů by byl kód jednoduše neudržitelný.
Kroky
Krok 1. Pochopte účel přidávání komentářů k počítačovému programu
- Klíčovou věcí je zde čitelnost. Když se podíváte na komentář, měli byste vědět, že se jedná o komentář, nikoli o řádek kódu.
- Komentář by měl být užitečný nejen pro vás, ale pro kohokoli jiného, kdo by si mohl přečíst zdrojový kód vašeho počítačového programu.
Krok 2. Vymyslete krátký a jednoduchý způsob, jak se dostat přes bod
Komentáře nemusí být uměleckým dílem. Měly by být stručné, úhledné a přímo k věci.
To by však nemělo odradit od použití více řádků pro komentář. Jde o to, že informace se musí dostat ke čtenáři
Krok 3. Napište komentář pomocí příslušné syntaxe dané programovacím jazykem
Krok 4. Zeptejte se sami sebe, zda je vámi napsaný komentář dostatečně podrobný
Komentář by měl být schopen někomu při pohledu na zdrojový kód říci, co ta část programu vlastně dělá, aniž by ji musel kompilovat a spouštět. Splňuje to váš komentář? Sděluje všechny detaily?