Opmerkingen schrijven in bash-scripts

Wanneer u Bash-scripts schrijft, is het altijd een goede gewoonte om uw code schoon en gemakkelijk te begrijpen te maken. Je code in blokken ordenen, inspringen, variabelen en functies beschrijvende namen geven, zijn verschillende manieren om dit te doen.

Een andere manier om de leesbaarheid van uw code te verbeteren, is door opmerkingen te gebruiken. Een opmerking is een voor mensen leesbare uitleg of aantekening die in het shellscript is geschreven.

Het toevoegen van opmerkingen aan uw Bash-scripts bespaart u veel tijd en moeite als u in de toekomst naar uw code kijkt. Stel dat u een script wilt wijzigen dat u enkele maanden of jaren geleden hebt geschreven. De kans is groot dat je niet meer weet waarom je een gecompliceerd stukje code hebt geschreven, tenzij je een opmerking hebt toegevoegd.

De opmerkingen helpen ook andere ontwikkelaars en systeembeheerders die mogelijk het script moeten onderhouden om uw code en het doel ervan te begrijpen.

Opmerkingen worden meestal gebruikt om uit te leggen wat de code niet kan. Als u bijvoorbeeld een complexe regex of parametervervanging in uw Bash-script heeft, moet u een opmerking schrijven over wat de code doet. Opmerkingen moeten kort en bondig zijn. Leg niet iets uit dat eenvoudig en duidelijk is voor de lezer.

, behandelen we de basisprincipes van het schrijven van opmerkingen in Bash.

Opmerkingen schrijven in Bash

Bash negeert alles wat na het hekje ( # ) op de regel staat. De enige uitzondering op deze regel is wanneer de eerste regel in het script begint met de #! karakters. Deze reeks tekens wordt Shebang genoemd en wordt gebruikt om het besturingssysteem te vertellen welke tolk moet worden gebruikt om de rest van het bestand te parseren.

Opmerkingen kunnen aan het begin op de regel of inline met andere code worden toegevoegd:

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

De lege ruimte achter het hekje is niet verplicht, maar het verbetert de leesbaarheid van de opmerking.

Meestal worden opmerkingen in het groen weergegeven wanneer het script in een teksteditor wordt geopend.

Opmerkingen zijn ook handig bij het testen van een script. In plaats van enkele regels of blokken te verwijderen, kunt u ze becommentariëren:

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

Multiline opmerkingen in Bash

In tegenstelling tot de meeste programmeertalen ondersteunt Bash geen commentaar op meerdere regels.

De eenvoudigste manier om opmerkingen met meerdere regels in Bash te schrijven, is om één voor één enkele opmerkingen toe te voegen:

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

Een andere optie is om HereDoc te gebruiken. Het is een soort omleiding waarmee u meerdere invoerregels aan een opdracht kunt doorgeven. Als het HereDoc-blok niet wordt omgeleid naar een opdracht, kan het dienen als een tijdelijke aanduiding voor opmerkingen over meerdere regels:

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

Het gebruik van HereDoc is een hack, geen echte ingebouwde manier om Bash-opmerkingen met meerdere regels te schrijven. Om problemen te voorkomen, kunt u het beste opmerkingen met één regel gebruiken.

Conclusie

Het schrijven van opmerkingen is een goede gewoonte en helpt andere ontwikkelaars, inclusief het toekomstige zelf, om het shellscript te begrijpen. In Bash wordt alles na het hekje ( # ) en tot het einde van de regel als een opmerking beschouwd.

Als u vragen of feedback heeft, kunt u een reactie achterlaten.

bash-terminal