Cosa sono i commenti in Ruby?
Un commento Ruby aggiunge al tuo codice informazioni che potrebbero essere utili per te o per altri sviluppatori.
Il tipo di commento più comune è il commento a riga singola.
Ecco la sintassi:
# I like apples & oranges
Notare tre cose:
- Il commento inizia con un simbolo pound (
#) - Mettiamo uno spazio tra il contenuto del commento & l’inizio del commento per rendere più facile la lettura
- Tutto all’interno del commento non è interpretato come codice, anche se sembra codice. Ciò significa che puoi commentare temporaneamente il codice per disabilitarlo.
È possibile utilizzare questi commenti da soli, o in linea, alla fine di una riga di codice.
.size # get array size
Ci sono altri tipi di commenti?
Sì, ci sono commenti magici, commenti multilinea & Commenti ERB.
Esploriamo quelli!
Come usare i commenti multilinea in Ruby
In Ruby, facciamo commenti multilinea con commenti regolari a riga singola.
Alcune persone chiamano questi “commenti di blocco”.
Ecco un esempio:
# aaa# bbb# ccc
Questo è esattamente come commentare un blocco di codice in ruby.
I moderni editor di codice consentono di selezionare un blocco di codice & commentarlo tutto utilizzando una scorciatoia da tastiera, quindi non è necessario alcuno sforzo aggiuntivo.
Ma c’è una speciale sintassi di commento multilinea.
Assomiglia a questo:
=beginThis is a comment...abc=end
Nessuno usa questa sintassi
È brutto & non puoi nemmeno usarlo all’interno di qualcosa che è rientrato (come un metodo), ma è bene sapere che esiste se lo trovi mai in natura.
Shebang Comments
Uno shebang (#!) è un tipo speciale di commento che dice a una shell Unix (come bash) come interpretare questo file.
Quando aggiungi questo commento nella parte superiore del tuo file
Sarai in grado di eseguire i tuoi file Ruby come file eseguibili, supponendo che abbiano i permessi giusti per farlo.
Ecco come appare un commento shebang:
#!/usr/bin/env ruby
Ciò consente anche di impostare specifiche opzioni della riga di comando, come l’opzione di avviso.
Esempio:
#!/usr/bin/env ruby -w
Ogni volta che esegui questo codice verrà eseguito con queste opzioni, quindi non devi passarle manualmente.
Come usare i commenti magici
Un commento magico modifica in qualche modo il comportamento dell’interprete Ruby.
Ad esempio:
Il commento frozen_string_literals renderà le tue stringhe congelate per impostazione predefinita.
Assomiglia a questo:
# frozen_string_literal: true
Un altro commento magico consente di modificare la codifica del file.
Ecco un esempio:
# encoding: utf-8
A eccone uno interessante, il commento warn_indent:
# warn_indent: true
Questo mostrerà un avviso ogni volta che il tuo rientro è sbagliato.
Esempio:
def comments end
Che si traduce in:
warning: mismatched indentations at 'end' with 'def' at 3
Commenti ERB
Se stai usando ERB per le tue visualizzazioni Rails & devi aggiungere un commento
Quindi puoi usare questa sintassi:
Non sono un grande fan di questo perché credo che dovresti tenere la maggior parte della tua logica fuori dalle tue opinioni, quindi non dovresti aver bisogno di commenti.
Stai cercando di disabilitare del codice per il debug?
Quindi elimina quel codice & trust git, o qualsiasi sistema di controllo della versione che stai usando.
Sommario
