Introduzione

Quando si scrivono script Bash, è sempre buona norma rendere il codice pulito e facilmente comprensibile. Organizzare il codice in blocchi, indentare, assegnare variabili e funzioni a nomi descrittivi sono diversi modi per farlo.

Un altro modo per migliorare la leggibilità del codice è utilizzare i commenti. Un commento è una spiegazione o annotazione leggibile dall'uomo scritta nello script della shell.

L'aggiunta di commenti ai tuoi script Bash ti farà risparmiare un sacco di tempo e fatica quando guarderai il tuo codice in futuro. Diciamo che vuoi cambiare una sceneggiatura che hai scritto alcuni mesi o anni fa. È probabile che non ricorderai perché hai scritto un pezzo di codice complicato se non hai aggiunto un commento.

I commenti aiutano anche altri sviluppatori e amministratori di sistema che potrebbero aver bisogno di mantenere lo script per comprendere il codice e il suo scopo.

I commenti vengono generalmente utilizzati per spiegare ciò che il codice non può. Ad esempio, se hai una regex complessa o una sostituzione dei parametri all'interno del tuo script Bash, dovresti scrivere un commento su ciò che fa il codice. I commenti dovrebbero essere brevi e pertinenti. Non spiegare qualcosa che sia semplice e ovvio per il lettore.

In questo articolo, tratteremo le basi per scrivere commenti in Bash.

Scrivere commenti in Bash

Bash ignora tutto ciò che è scritto dopo il segno di hash (#) sulla riga. L'unica eccezione a questa regola è quando la prima riga dello script inizia con i #! caratteri. Questa sequenza di caratteri si chiama Shebang e viene utilizzata per indicare al sistema operativo quale interprete utilizzare per analizzare il resto del file.

I commenti possono essere aggiunti all'inizio sulla riga o in linea con altri codici:

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

Lo spazio vuoto dopo il segno di hash non è obbligatorio, ma migliorerà la leggibilità del commento.

Di solito, quando lo script viene aperto in un editor di testo, i commenti vengono rappresentati in verde.

I commenti sono utili anche durante il test di uno script. Invece di eliminare alcune righe o blocchi, puoi commentarli:

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

Commenti multilinea in Bash

A differenza della maggior parte dei linguaggi di programmazione, Bash non supporta i commenti multilinea.

Il modo più semplice per scrivere commenti multilinea in Bash è aggiungere singoli commenti uno dopo l'altro:

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

Un'altra opzione è utilizzare HereDoc. È un tipo di reindirizzamento che consente di passare più righe di input a un comando. Se il blocco HereDoc non viene reindirizzato a un comando, può fungere da segnaposto per commenti multilinea:

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

L'uso di HereDoc è un hack, non un vero modo incorporato per scrivere commenti Bash su più righe. Per evitare problemi, è preferibile utilizzare i commenti a riga singola.

Conclusione

Scrivere commenti è una buona pratica e aiuta altri sviluppatori, incluso il sé futuro, a comprendere lo script della shell. In Bash, tutto ciò che segue il segno di hash (#) e fino alla fine della riga è considerato un commento.