Psaní komentářů v bash skriptech

Při psaní skriptů Bash je vždy dobré zajistit, aby byl váš kód čistý a snadno pochopitelný. Organizace kódu v blocích, odsazení, zadání proměnných a funkcí popisných názvů je několik způsobů, jak toho dosáhnout.

Dalším způsobem, jak zlepšit čitelnost kódu, je použití komentářů. Komentář je lidsky čitelné vysvětlení nebo anotace napsané ve skriptu shellu.

Přidání komentářů do vašich skriptů Bash vám ušetří spoustu času a úsilí, když se v budoucnu podíváte na svůj kód. Řekněme, že chcete změnit skript, který jste napsali před několika měsíci nebo lety. Je pravděpodobné, že si nebudete pamatovat, proč jste napsali nějaký složitý kus kódu, pokud jste nepřidali komentář.

Komentáře také pomáhají dalším vývojářům a správcům systému, kteří potřebují skript udržovat, aby porozuměli vašemu kódu a jeho účelu.

Poznámky se obvykle používají k vysvětlení toho, co kód nemůže. Pokud například máte uvnitř skriptu Bash komplexní substituci regexu nebo parametru, měli byste napsat komentář o tom, co kód dělá. Komentáře by měly být krátké a věcné. Nevysvětlujte něco, co je pro čtenáře jednoduché a zřejmé.

, pokryjeme základy psaní komentářů v Bash.

Psaní komentářů v Bash

Bash ignoruje vše, co je zapsáno za značkou hash ( # ) na řádku. Jedinou výjimkou z tohoto pravidla je, když první řádek skriptu začíná znakem #! postavy. Tato posloupnost znaků se nazývá Shebang a používá se ke sdělení operačnímu systému, který interpret má použít k analýze zbytku souboru.

Komentáře lze přidat na začátek na řádek nebo vložit do jiného kódu:

# This is a Bash comment. echo "This is Code" # This is an inline Bash comment.

Prázdné místo za značkou hash není povinné, ale zlepší čitelnost komentáře.

Když je skript otevřen v textovém editoru, komentáře se obvykle zobrazují zeleně.

Komentáře jsou také užitečné při testování skriptu. Místo odstranění některých řádků nebo bloků je můžete komentovat:

# if]; then # echo "Variable is greater than 10." # fi

Víceřádkové komentáře v Bash

Na rozdíl od většiny programovacích jazyků Bash nepodporuje víceřádkové komentáře.

Nejjednodušší způsob, jak v Bashu psát víceřádkové komentáře, je přidat jednotlivé komentáře jeden po druhém:

# This is the first line. # This is the second line.

Další možností je použití HereDoc. Jedná se o typ přesměrování, který umožňuje předat více příkazů vstupu příkazu. Pokud blok HereDoc není přesměrován na příkaz, může sloužit jako zástupný symbol pro víceřádkové komentáře:

<< 'MULTILINE-COMMENT' Everything inside the HereDoc body is a multiline comment MULTILINE-COMMENT

Použití HereDoc je hack, není skutečný vestavěný způsob, jak psát víceřádkové Bash komentáře. Chcete-li se vyhnout jakýmkoli problémům, měli byste raději použít jednorázové komentáře.

Závěr

Psaní komentářů je dobrá praxe a pomáhá ostatním vývojářům, včetně budoucího já, porozumět skriptu shellu. V Bash je za komentářem označeno vše za značkou hash ( # ) a do konce řádku.

Pokud máte nějaké dotazy nebo zpětnou vazbu, neváhejte zanechat komentář.

bash terminál