Pojďme se společně podívat na to, co vlastně komentáře v programování jsou a proč hrají tak zásadní roli.
Prozkoumáme dva základní druhy komentářů a ukážeme si, jak se zapisují v patnácti různých programovacích jazycích.
Co jsou komentáře v programování?
Zjednodušeně řečeno, komentáře jsou textové poznámky v kódu, které nejsou určeny pro koncové uživatele. Jejich hlavním účelem je usnadnit práci programátorům.
Formálněji, komentář je popis funkce kódu, který je prezentován v jednoduché, srozumitelné podobě. Obvykle se používá v místech, kde je nutné poskytnout vývojáři čtoucímu kód dodatečné vysvětlení. To výrazně zvyšuje čitelnost kódu, šetří čas a zjednodušuje předávání znalostí.
Kompilátor nebo interpret komentáře v kódu ignoruje, takže nemají žádný vliv na výsledný výstup programu. Zkrátka, komentáře jsou jako stručné a jasné vysvětlivky k určitým částem kódu.
Běžné typy komentářů
Většina programovacích jazyků umožňuje používat dva základní typy komentářů:
- Jednořádkové komentáře
- Víceřádkové komentáře (blokové komentáře)
Jak již název napovídá, jednořádkové komentáře se hodí pro krátké poznámky, například k vysvětlení konkrétní podmínky nebo konstantní hodnoty. Víceřádkové komentáře jsou ideální pro delší texty, například pro popis funkce a jejího použití.
Existují i další druhy komentářů, jako například dokumentační komentáře, ale ty se v tomto článku probírat nebudeme.
Proč psát komentáře?
„Každý může napsat kód, kterému rozumí počítač. Dobří programátoři píší kód, kterému rozumí lidé.“ – Martin Fowler
Hlavním přínosem komentářů je zlepšení čitelnosti a srozumitelnosti kódu. Mezi další výhody patří:
- Komentáře usnadňují kolegům i dalším vývojářům pochopit logiku kódu bez nutnosti pročítat obsáhlou dokumentaci.
- Snižují potřebu komunikace mezi vývojáři ohledně drobných nejasností.
- Kompilátory a interprety komentáře jednoduše ignorují.
- U softwaru s otevřeným zdrojovým kódem jsou komentáře nezbytné, protože není možné vysvětlovat každou funkci milionům vývojářů, kteří chtějí software používat.
Komentáře v různých jazycích
Výborně, nyní už víme, co jsou komentáře a k čemu slouží. Podívejme se, jak je zapisovat v různých programovacích jazycích.
Jednořádkový komentář
// Toto je jednořádkový komentář v C/C++
Víceřádkový komentář
/* Toto je delší víceřádkový komentář v C/C++ */
Jednořádkový komentář
# Toto je jednořádkový komentář v Pythonu
Víceřádkový komentář
# Toto je delší # víceřádkový komentář v Pythonu
Jednořádkový komentář
// Toto je jednořádkový komentář v Javě
Víceřádkový komentář
/* Toto je delší víceřádkový komentář v Javě */
Jednořádkový komentář
# Toto je jednořádkový komentář v Ruby
Víceřádkový komentář
=begin Toto je delší víceřádkový komentář v Ruby =end
Jednořádkový komentář
// Toto je jednořádkový komentář v Golangu
Víceřádkový komentář
/* Toto je delší víceřádkový komentář v Golangu */
Jednořádkový komentář
-- Toto je jednořádkový komentář v Haskellu
Víceřádkový komentář
{- Toto je delší
víceřádkový komentář v Haskellu -}
Jednořádkový komentář
// Toto je jednořádkový komentář v Rustu
Víceřádkový komentář
/* Toto je delší víceřádkový komentář v Rustu */
Jednořádkový komentář
<!-- Toto je jednořádkový komentář v HTML -->
Víceřádkový komentář
<!-- Toto je delší víceřádkový komentář v HTML -->
Jednořádkový komentář
/* Toto je jednořádkový komentář v CSS */
Víceřádkový komentář
/* Toto je delší víceřádkový komentář v CSS */
Jednořádkový komentář
// Toto je jednořádkový komentář v Javascriptu
Víceřádkový komentář
/* Toto je delší víceřádkový komentář v Javascriptu */
Jednořádkový komentář
# Toto je jednořádkový komentář v jazyce R
Víceřádkové komentáře jazyk R nepodporuje.
Jednořádkový komentář
% Toto je jednořádkový komentář v Erlang
Víceřádkové komentáře jazyk Erlang nepodporuje.
Jednořádkový komentář
// Toto je jednořádkový komentář v PHP
Víceřádkový komentář
/* Toto je delší víceřádkový komentář v PHP */
Jednořádkový komentář
# Toto je jednořádkový komentář v Perlu
Víceřádkový komentář
=begin Toto je delší víceřádkový komentář v Perlu =end
Jednořádkový komentář
// Toto je jednořádkový komentář v Kotlinu
Víceřádkový komentář
/* Toto je delší víceřádkový komentář v Kotlinu */
Závěr
V tomto článku jsme si vysvětlili základy komentářů a dva nejběžnější typy – jednořádkové a víceřádkové. Dále jsme se zaměřili na důležitost komentářů a to, proč je vhodné je používat. Doufám, že jste se dozvěděli něco nového!
Pokračujte v objevování. Neustále se učte! 👨💻