Come commentare in Ruby

Ad un certo punto o nell'altro, ogni sviluppatore si trova in una situazione in cui devono modificare il codice sorgente di uno script. Senza documentazione e informazioni adeguate per guidarti, facendo che diventa quasi impossibile. È qui che entra in gioco il concetto di commento sul tuo codice.

I commenti sono semplicemente informazioni aggiunte al codice sorgente di un programma a fini di documentazione. Gli interpreti e i compilatori del linguaggio ignorano i commenti. Sebbene l'uso principale dei commenti sia di documentare e descrivere le operazioni di un blocco di codice, possono essere convenienti durante il debug del codice.

In questo tutorial, impareremo vari modi per commentare il codice negli script di Ruby.

Uso di base: commenti a riga singola

Esistono vari tipi di commenti in Ruby. Tuttavia, il più semplice è un commento a riga singola.

Inizia con un simbolo di libbra (#) e continua fino alla fine della linea.

# Commento a riga singola Ruby
Stampa "Ciao da Ruby!"

Come puoi vedere nell'esempio sopra, il commento a riga singola inizia con il simbolo della sterlina e si estende fino alla fine della linea.

L'interprete di Ruby ignora il testo all'interno del commento a riga singola, anche se trasporta un codice Ruby valido.

Un commento a riga singola in Ruby può iniziare all'inizio di una riga o della fine, come mostrato di seguito:

Stampa "Ciao da Ruby!" # Commento a riga singola Ruby

In questo caso, il contenuto prima del segno sterlina (#) viene conteggiato come codice Ruby valido mentre il contenuto dopo non è.

Commenti di blocco/multiline

In altri casi, è necessario descrivere ciò che il codice fa in modo più dettagliato. Per includere commenti che si estendono in più righe in Ruby, implementiamo i commenti a blocchi.

Esistono due modi per implementare i commenti di blocco in Ruby:

1: = inizio/= fine

Questo metodo utilizza il formato = inizio e = fine per racchiudere le righe all'interno del blocco come commenti.

Ecco un esempio:

= Inizia
Questo è un commento
che si estende su più righe
ed è molto utile per la documentazione dettagliata
= fine
Stampa "Hi Block Commenti!"

In questo tipo di commento, iniziamo usando la parola chiave = inizio seguita da tutte le righe su cui desideriamo commentare e chiudere = end.

L'uso di questo formato di commento è raro perché non offre molta flessibilità nella formattazione dei commenti ed è molto illeggibile.

2: simboli multipli (#)

Il modo più comune di commentare più righe in Ruby è pre-appendere ogni riga con un segno di sterlina.

Ecco un esempio:

# Questo è un altro metodo di commento
# che copre più righe
# ed è molto utile per la documentazione dettagliata

In questo caso, abbiamo più righe commentate. Usando i redattori moderni, puoi evidenziare un blocco di codice e commentarlo subito.

Commenti e commenti magici

Ruby è un linguaggio interessante perché offre commenti magici. I commenti magici prendono un formato simile ai commenti regolari, ma invece di essere ignorati dall'interprete, cambiano il comportamento dell'interprete.

I commenti magici contengono direttive di Ruby che definiscono cosa modificare sull'interprete.

L'esempio seguente mostra un commento magico per modificare la codifica per i letterali delle stringhe.

# codifica: UTF-8

Sebbene quanto sopra sia simile a un commento regolare, contiene una direttiva riconosciuta da Ruby.

Per saperne di più sulle direttive dei commenti magici, considera la documentazione dei commenti di Ruby.

Riepilogo

Questa guida rapida ha discusso di vari tipi di commenti di Ruby, incluso come implementarli con facilità.