Utilizzo dei commenti in Ruby

I commenti nel tuo codice Ruby sono note e annotazioni che devono essere lette da altri programmatori. I commenti stessi vengono ignorati dall'interprete Ruby, quindi il testo all'interno dei commenti non è soggetto ad alcuna restrizione.

Di solito è una buona forma mettere commenti prima di classi e metodi, nonché qualsiasi parte di codice che può essere complessa o poco chiara.

Utilizzo efficace dei commenti

I commenti devono essere usati per fornire informazioni di base o annotare il codice difficile. Le note che dicono semplicemente cosa fa la prossima riga di codice semplice non sono solo ovvie, ma aggiungono anche disordine al file.

È importante fare attenzione a non usare troppi commenti e assicurarsi che i commenti fatti nel file siano significativi e utili per altri programmatori.

The Shebang

Noterai che tutti i programmi Ruby iniziano con un commento che inizia con #!. Questo si chiama a faccenda e viene utilizzato su sistemi Linux, Unix e OS X..

Quando esegui uno script Ruby, la shell (come bash su Linux o OS X) cercherà uno shebang nella prima riga del file. La shell utilizzerà quindi lo shebang per trovare l'interprete Ruby ed eseguire lo script.

Il ruby ​​shebang preferito è #! / usr / bin / env ruby, anche se potresti anche vedere #! / Usr / bin / ruby o #! / Usr / local / bin / ruby.

Commenti a riga singola

Il commento su una riga di Ruby inizia con # carattere e termina alla fine della riga. Qualsiasi personaggio di # il carattere fino alla fine della riga viene completamente ignorato dall'interprete Ruby.

Il # il personaggio non deve necessariamente apparire all'inizio della riga; può succedere ovunque.

L'esempio seguente mostra alcuni usi dei commenti.

 #! / usr / bin / env ruby

 # Questa riga viene ignorata dall'interprete Ruby

 # Questo metodo stampa la somma dei suoi argomenti

 def sum (a, b)

   mette a + b

 fine

 sum (10,20) # Stampa la somma di 10 e 20 

Commenti su più righe

Anche se spesso dimenticato da molti programmatori di Ruby, Ruby ha commenti su più righe. Un commento su più righe inizia con = inizio token e termina con il = fine gettone.

Questi token dovrebbero iniziare all'inizio della linea ed essere l'unica cosa sulla linea. Qualunque cosa tra questi due token viene ignorata dall'interprete Ruby.

 #! / usr / bin / env ruby

 = inizio

 Tra = inizio e = fine, qualsiasi numero

 di righe può essere scritto. Tutti questi

 le linee vengono ignorate dall'interprete Ruby.

 = fine

 mette "Ciao mondo!"

In questo esempio, il codice verrebbe eseguito come Ciao mondo!