1.1.5 Documentare programmi gawk.

Un commento è del testo incluso in un programma per aiutare le persone che lo leggeranno; non è parte del programma eseguibile vero e proprio. I commenti possono spiegare cosa fa il programma e come funziona. Quasi tutti i linguaggi di programmazione possono contenere commenti, poiché i programmi sono solitamente difficili da comprendere senza di essi.

Nel linguaggio awk, un commento inizia con il segno del cancelletto (‘#’) e continua fino alla fine della riga. Il ‘#’ non deve necessariamente essere il primo carattere della riga. Il linguaggio awk ignora il resto di una riga dopo il carattere cancelletto. Per esempio, potremmo mettere quel che segue in consiglio:

# Questo programma stampa uno scherzoso consiglio amichevole.
# Aiuta a far passare la paura del computer agli utenti novelli.
BEGIN    { print "Non v'allarmate!" }

Si possono mettere dei commenti nei programmi awk usa-e-getta da digitare direttamente da tastiera, ma ciò solitmanete non serve molto; il fine di un commento è di aiutare l’utente o qualcun altro a comprendere il programma, quando lo rilegge in un secondo tempo.

ATTENZIONE: Come detto in Eseguire un breve programma awk usa-e-getta, si possono includere programmi di dimensioni da piccole a medie tra apici singoli, per mantenere compatti i propri script di shell autocontenuti. Nel far questo, non bisogna inserire un apostrofo (ossia un apice singolo) in un commento, (o in qualsiasi altra parte del vostro programma). La shell interpreta gli apici singoli come delimitatori di chiusura dell’intero programma. Di conseguenza, solitamente la shell emette un messaggio riguardo ad apici presenti in numero dispari, e se awk viene comunque eseguito, è probabile che stampi strani messaggi di errori di sintassi. Per esempio, nel caso seguente:

$ awk 'BEGIN { print "Ciao" } # un'idea brillante'
>

La shell considera il secondo apice singolo come delimitatore del testo precedente, e trova che un nuovo testo tra apici ha inizio verso la fine della riga di comando. A causa di ciò emette una richiesta secondaria di input, e si mette in attesa di ulteriore input. Con il comando awk Unix, se si chiude l’ulteriore stringa tra apici singoli il risultato è il seguente:

$ awk '{ print "Ciao" } # un'idea brillante'
> '
error→ awk: fatale: non riesco ad aprire file `brillante'
error→              in lettura (File o directory non esistente)

Mettere una barra inversa prima dell’apice singolo in ‘un'idea’ non risolverebbe, poiché le barre inverse non sono speciali all’interno di apici singoli. La prossima sottosezione descrive le regole di protezione della shell.