Skriva kommentarer i basskript

När du skriver Bash-skript är det alltid bra att göra din kod ren och lättförståelig. Organisera din kod i block, indrag, ge variabler och funktioner beskrivande namn är flera sätt att göra detta.

Ett annat sätt att förbättra läsbarheten för din kod är genom att använda kommentarer. En kommentar är en mänsklig läsbar förklaring eller kommentar som skrivs i skalskriptet.

Att lägga till kommentarer till dina Bash-skript sparar dig mycket tid och ansträngning när du tittar på din kod i framtiden. Låt oss säga att du vill ändra ett manus som du skrev för några månader eller år sedan. Chansen är stor att du inte kommer ihåg varför du skrev en komplicerad kod om du inte har lagt till en kommentar.

Kommentarerna hjälper också andra utvecklare och systemadministratörer som kan behöva underhålla skriptet för att förstå din kod och dess syfte.

Kommentarer används vanligtvis för att förklara vad koden inte kan. Om du till exempel har en komplex regex- eller parametersubstitution i ditt Bash-skript, bör du skriva en kommentar om vad koden gör. Kommentarerna bör vara korta och till punkten. Förklara inte något som är enkelt och uppenbart för läsaren.

, vi täcker grunderna för att skriva kommentarer i Bash.

Skriva kommentarer i Bash

Bash ignorerar allt som skrivs efter hashmärket ( # ) på linjen. Det enda undantaget från denna regel är när den första raden på skriptet börjar med #! tecken. Denna sekvens med tecken kallas Shebang och används för att berätta för operativsystemet vilken tolk som ska användas för att analysera resten av filen.

Kommentarer kan läggas till i början på raden eller inline med annan kod:

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

Det tomma utrymmet efter hashmärket är inte obligatoriskt, men det kommer att förbättra kommentarens läsbarhet.

Vanligtvis när skriptet öppnas i en textredigerare representeras kommentarer med grönt.

Kommentarer är också användbara när man testar ett skript. I stället för att radera några rader eller block kan du kommentera dem:

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

Multiline-kommentarer i Bash

Till skillnad från de flesta programmeringsspråk stöder Bash inte flerlinjekommentarer.

Det enklaste sättet att skriva multiline-kommentarer i Bash är att lägga till enstaka kommentarer efter varandra:

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

Ett annat alternativ är att använda HereDoc. Det är en typ av omdirigering som gör att du kan skicka flera inmatningsrader till ett kommando. Om HereDoc-blocket inte omdirigeras till ett kommando kan det fungera som en platshållare för flera linjer:

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

Att använda HereDoc är ett hack, inte ett riktigt inbyggt sätt att skriva multiline Bash-kommentarer. För att undvika problem bör du föredra att använda kommentarer på en rad.

Slutsats

Att skriva kommentarer är en bra praxis och hjälper andra utvecklare, inklusive framtida jag, att förstå skalskriptet. I Bash anses allt efter hashmärket ( # ) och fram till slutet av raden vara en kommentar.

Om du har några frågor eller feedback kan du lämna en kommentar.

bash terminal