Escriure comentaris a Bash Scripts

Bloc

Escriure comentaris a Bash Scripts

Escriure comentaris a Bash Scripts

Quan escriviu scripts de Bash, sempre és una bona pràctica fer que el vostre codi sigui net i fàcil d’entendre. Organitzar el codi en blocs, sagnar, donar variables i funcions a noms descriptius són diverses maneres de fer-ho.

comerç electrònic Hugo

Una altra manera de millorar la llegibilitat del vostre codi és mitjançant l’ús de comentaris. Un comentari és una explicació o anotació llegible per l’home que s’escriu a l’escriptura de l’intèrpret d’ordres.

Si afegiu comentaris als vostres scripts de Bash, estalvieu molt de temps i d’esforç quan mireu el vostre codi en el futur. Suposem que voleu canviar un guió que vau escriure fa uns mesos o uns anys. El més probable és que no recordeu per què vau escriure algun fragment de codi complicat tret que hi afegiríeu un comentari.

Els comentaris també ajuden a altres desenvolupadors i administradors de sistemes que poden necessitar mantenir l'script per entendre el vostre codi i el seu propòsit.

Els comentaris s’utilitzen per explicar el codi. Per exemple, si teniu una regex complexa o una substitució de paràmetres dins del vostre script Bash, heu d'escriure un comentari que descrigui el que fa el codi. Els comentaris han de ser curts i puntuals. No expliqueu alguna cosa que sigui senzilla i òbvia per al lector.

En aquest article, tractarem els conceptes bàsics per escriure comentaris a Bash.

Escriure comentaris a Bash

Bash ignora tot el que hi ha escrit a la línia després de la marca hash (#). L'única excepció a aquesta regla és quan la primera línia de l'script comença amb el #! personatges. Es diu aquesta seqüència de caràcters Shebang i s'utilitza per indicar al sistema operatiu quin intèrpret ha d'utilitzar per analitzar la resta del fitxer.

Els comentaris es poden afegir al principi a la línia o en línia amb un altre codi:

aplicació en efectiu no s'ha pogut enviar el pagament
# This is a Bash comment. echo 'This is Code' # This is an inline Bash comment.

Copia

on comprar hoge

L'espai en blanc després de la marca hash no és obligatori, però millorarà la llegibilitat del comentari.

Si el teu editor de text admet ressaltat de sintaxi, els comentaris solen representar-se en verd.

Els comentaris també són útils a l’hora de provar un script. En lloc de suprimir algunes línies o blocs, podeu comentar-les:

# if [[ $VAR -gt 10 ]]; then # echo 'Variable is greater than 10.' # fi

#bash #bash scripts #terminal