Při psaní skriptů Bash je vždy dobrým zvykem, aby byl váš kód čistý a snadno srozumitelný. Uspořádání kódu do bloků, odsazení, přidělování proměnných a popisných názvů funkcí je několik způsobů, jak toho dosáhnout.
Dalším způsobem, jak zlepšit čitelnost kódu, je používání komentářů. Komentář je pro člověka čitelné vysvětlení nebo anotace, která je napsána ve skriptu shellu.
Přidávání komentářů ke skriptům Bash vám ušetří spoustu času a úsilí, když se budete v budoucnu dívat 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ý komplikovaný kus kódu, dokud nepřidáte komentář.
Komentáře také pomáhají dalším vývojářům a správcům systému, kteří mohou potřebovat udržovat skript, aby pochopili váš kód a jeho účel.
Komentáře se používají k vysvětlení kódu. Pokud například máte ve skriptu Bash složitý regulární výraz nebo náhradu parametrů, měli byste napsat komentář popisující, co kód dělá. Komentáře by měly být krátké a výstižné. Nevysvětlujte něco, co je pro čtenáře jednoduché a zřejmé.
V tomto článku se budeme zabývat základy psaní komentářů v Bash.
Psaní komentářů v Bash #
Bash ignoruje vše, co je napsáno na řádku za značkou hash (# ). Jedinou výjimkou z tohoto pravidla je, když první řádek skriptu začíná znakem #! znaky. Tato sekvence znaků se nazývá Shebangand a používá se k tomu, aby řekl operačnímu systému, který interpret má použít k analýze zbytku souboru.
Komentáře lze přidat na začátek řádku nebo na řádek s jiným kódem:
# This is a Bash comment.
echo "This is Code" # This is an inline Bash comment.
Prázdné místo za křížkem není povinné, ale zlepší se čitelnost komentáře.
Pokud váš textový editor podporuje zvýraznění syntaxe, komentáře jsou obvykle znázorněny zeleně.
Komentáře jsou také užitečné při testování skriptu. Místo mazání některých řádků nebo bloků je můžete okomentovat:
# if [[ $VAR -gt 10 ]]; 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 psát víceřádkové komentáře v Bash, je přidávat jednotlivé komentáře jeden po druhém:
# This is the first line.
# This is the second line.
Další možností je použít HereDoc. Je to typ přesměrování, který umožňuje předat příkazu více řádků vstupu. Pokud není blok HereDoc 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í to skutečný vestavěný způsob psaní víceřádkových komentářů Bash. Abyste předešli problémům, měli byste raději používat jednořádkové komentáře.
Závěr č.
Psaní komentářů je dobrou praxí a pomáhá ostatním vývojářům, včetně budoucích já, pochopit skript shellu. V Bash je vše za značkou hash (# ) a až do konce řádku se považuje za komentář.
Pokud máte nějaké dotazy nebo zpětnou vazbu, neváhejte zanechat komentář.