Pojďme zjistit, co jsou komentáře a proč jsou důležité v programování.
Zabýváme se také dvěma běžnými typy komentářů a jejich psaním v 15 různých programovacích jazycích.
Table of Contents
Co jsou komentáře v programování?
Komentáře v laickém vyjádření jsou části textu, které nebudou viditelné pro koncové uživatele a slouží lidem, kteří píší kód.
Trochu formálněji je komentář popis programu o tom, jak funguje, v jednoduchém čitelném formátu. Ty se obvykle používají na místech, kde je třeba vývojáři, který čte kód, poskytnout určitou další srozumitelnost. Tím to pomáhá zlepšit čitelnost kódu a zkracuje čas a komunikaci, které by byly zapotřebí pro přenos znalostí.
Kompilátor/interpret jednoduše ignoruje komentáře ve vašem kódu, čímž neovlivňuje konečný výstup vašeho programu. Stručně řečeno, komentáře jsou jako jednoduché čitelné vysvětlení určitých částí kódu.
Běžné typy komentářů
Většina programovacích jazyků podporuje 2 typy komentářů.
- Jednořádkový komentář
- Víceřádkový komentář / blokové komentáře
Jak název napovídá, jednořádkové komentáře jsou užitečné, když potřebujete přidat malý jednořádkový text, např. konkrétní podmínka, konstantní hodnota, která vyžaduje malý popis. Zatímco víceřádkový funguje lépe, když máme k dispozici větší množství informací, jako je popis funkce a jak ji lze použít atd.
Existují některé další typy komentářů, jako jsou komentáře k dokumentu, ale to je mimo rozsah tohoto článku.
Proč byste měli přidávat komentáře?
„Každý blázen dokáže napsat kód, kterému počítač rozumí. Dobří programátoři píší kód, kterému lidé rozumí.“ – Martin Fowler
Hlavní výhodou přidávání komentářů je lepší čitelnost a lepší porozumění programu. Kromě toho existují některé další výhody –
- Komentáře usnadňují vašim kolegům a dokonce i dalším vývojářům pochopit logiku, aniž by museli číst dlouhou dokumentaci.
- Snížená komunikace mezi vývojáři pro malé pochybnosti
- Překladač/interpreti komentáře ignorují.
- U softwaru s otevřeným zdrojovým kódem je to nutnost, protože nebudete muset vysvětlovat každou funkci milionům vývojářů, kteří chtějí daný program používat.
Komentáře ve více jazycích
Skvělé, teď, když jsme se dozvěděli o komentářích a proč jsou užitečné. Pojďme prozkoumat, jak můžeme přidávat komentáře v různých programovacích jazycích.
Jednořádkový komentář
// This is a single line comment in C/C++
Víceřádkový komentář
/* This is slightly long multi line comment in C/C++ */
Jednořádkový komentář
# This is a single line comment in Python
Víceřádkový komentář
# This is slightly long # multi line comment in Python
Jednořádkový komentář
// This is a single line comment in Java
Víceřádkový komentář
/* This is slightly long multi line comment in Java */
Jednořádkový komentář
# This is a single line comment in Ruby
Víceřádkový komentář
=begin This is slightly long multi line comment in Ruby =end
Jednořádkový komentář
// This is a single line comment in Golang
Víceřádkový komentář
/* This is slightly long multi line comment in Golang */
Jednořádkový komentář
– – This is a single line comment in Haskell
Víceřádkový komentář
{- This is slightly long
multi line comment in Haskell -}
Jednořádkový komentář
// This is a single line comment in Rust
Víceřádkový komentář
/* This is slightly long multi line comment in Rust */
Jednořádkový komentář
<!-- This is a single line comment in HTML -->
Víceřádkový komentář
<!-- This is slightly long multi line comment in HTML -->
Jednořádkový komentář
/* This is a single line comment in CSS */
Víceřádkový komentář
/* This is slightly long multi line comment in CSS */
Jednořádkový komentář
// This is a single line comment in Javascript
Víceřádkový komentář
/* This is slightly long multi line comment in Javascript */
Jednořádkový komentář
# This is a single line comment in R programming language
Víceřádkový komentář
R nepodporuje víceřádkové komentáře.
Jednořádkový komentář
% This is a single line comment in Erlang
Víceřádkový komentář
R nepodporuje víceřádkové komentáře.
Jednořádkový komentář
// This is a single line comment in PHP
Víceřádkový komentář
/* This is slightly long multi line comment in PHP */
Jednořádkový komentář
# This is a single line comment in Perl
Víceřádkový komentář
=begin This is slightly long multi line comment in Perl =end
Jednořádkový komentář
// This is a single line comment in Kotlin
Víceřádkový komentář
/* This is slightly long multi line comment in Kotlin */
Závěr
Výukový program pokryl základy komentářů a 2 běžné typy – jednořádkové a víceřádkové. Snažil jsem se také pokrýt, proč jsou komentáře užitečné a člověk by je měl psát, když je to potřeba. Doufám, že jste se naučili něco nového!
Pokračujte ve zkoumání. Stále se uč! 👨💻