È buona pratica avere variabili locali che iniziano con il carattere di sottolineatura?

Question

Sto entrando in Ruby e provengo dall'ambiente Java e C/C++.

Durante la codifica di un primo piccolo progetto in Ruby, in qualche modo mi sono abituato a lasciare che tutte le variabili locali inizino con un trattino basso. Immagino che la mia motivazione principale fosse una migliore leggibilità e distinzione dalle chiamate ai metodi.

Come in principio ci sono solo tre tipi di variabili ($global, @instance e local), la maggior parte delle variabili inizia con un trattino basso. Non sono sicuro, se questo è buono o cattivo. Inoltre, in molte altre lingue, il carattere di sottolineatura sarebbe sostituito da un altro personaggio.

C'è in qualche modo una denominazione variabile migliori pratiche riguardante accanto alla solita CamelCase e/o sottolineatura separati? Quali sono le abitudini dei "rubyists" professionali? Ho trascurato alcune convenzioni generali di Ruby, quando ho scelto il trattino basso principale?

---

modificare
Grazie a tutte le risposte e suggerimenti. Mi ha aiutato molto.

---

breve riassunto delle risposte e commenti di seguito
(per il visitatore a breve on-time)

sottolineature principali vanno con:

• metodo argomenti: def my_method(_my_arg)
• argomenti del blocco: ad es. my_array.each { |_x| puts _x}

Tutte le altre variabili locali senza trattini bassi di sottolineatura, come programmatori provenienti da ad es. JavaScript might get confused sul comportamento previsto delle variabili.

Per la separazione visiva tra i nomi delle variabili e chiamate di metodo, costringendo se stessi per usare "(" staffe ")" con tutte chiamate di metodo potrebbe aumentare in modo significativo la leggibilità.

Answer 1

Niente di sbagliato con la tua idea. Ma se avessi difficoltà a distinguere le vars locali dalle chiamate ai metodi, probabilmente mi costringerei a usare sempre i metodi (). (Il mio team al lavoro ha discusso di rendere questa parte dei nostri standard di codifica).

a = thing # var 
b = thing() # method 

Il vantaggio possibile è la leggibilità per gli altri. Qualcuno potrebbe chiedersi le tue iniziali, ma usare () su tutte le chiamate di metodo dovrebbe essere chiaro a tutti.

Answer 2

Nella mia esperienza, le variabili con prefisso sottolineato in Ruby sono molto simili a variabili prefissate in JavaScript: un flag "non toccare". Più specificamente, vengono usati quando l'implementatore sta facendo qualcosa che non dovrebbe essere inteso come parte dell'oggetto, o non dovrebbe essere pensato come l'interfaccia concettuale dell'oggetto.

Questo è più chiaro nel mondo JavaScript, dove qualcuno emula "privato" prefiggendo una variabile con un trattino basso. Stanno codificando che c'è una parte dell'oggetto che è sotto il cofano e può essere ignorata quando si guarda l'oggetto dall'esterno.

In Ruby, l'ho visto solo con cose come una cache o un'istanza singleton, il tipo di cosa che dovrebbe essere invisibile ai consumatori del tuo oggetto. Le variabili non sottolineate sono cose che le persone che usano il tuo oggetto potrebbero essere interessate a sapere che ci sono.

In ogni caso, sembrano abbastanza rari, e vorrei evitarli a meno che non vogliate inviare un segnale al prossimo che sta arrivando che ci sia un po 'di magia o di voodoo in più.

Per fare una distinzione per le chiamate di metodo, se si è preoccupati che possa esserci confusione tra un metodo e una variabile locale, chiamare il metodo su self per chiarire. Per esempio:

def foo 
    ... 
end 

def some_method 
    foo # method 
    bar # variable 
end 

Se questo vi sembra poco chiaro per qualsiasi motivo, è possibile chiarire con

def some_method 
    self.foo 
    bar 
end 

Answer 3

Visto che le variabili di istanza sono il segno @ di fronte a loro, e le variabili globali hanno il segno $ di fronte a loro già in ruby, probabilmente non è necessario mettere un carattere di sottolineatura davanti ai nomi delle variabili. Detto questo, non penso che sia necessariamente una cattiva pratica. Se ti aiuta a leggere o scrivere il tuo codice in Ruby, dovresti usarlo.

A volte ho visto il codice Ruby dove un argomento per un metodo di istanza su una classe ha un trattino di sottolineatura di fronte ad esso. Come ad esempio:

def my_method(_argument1) 
    # do something 
end 

E penso che quando hai a che fare con una classe che può avere è di possedere gli attributi, come un file di modello di rotaie, per esempio, questo può essere utile in modo che si sa che si sta trattando una variabile che è stata passata nel metodo in contrasto con uno degli attributi che appartengono alla classe/modello.

Answer 4

Le risposte esistenti a questa domanda hanno ormai alcuni anni e le convenzioni sono cambiate. Dovresti sempre usare solo un trattino basso (_some_param) o un trattino basso indipendente (_), per indicare che non ti interessa il valore. Lo strumento di linting dello stile rubocop si occuperà di un "inutile compito" se assegni una variabile ma non la usi, ma ignorerà le variabili con un trattino di sottolineatura principale. Questo ti consente di indicare espressamente che non ti importa del valore e non intendi usarlo.

Ecco un esempio un po 'artificiosa-casi d'uso in un contesto RSpec:

describe 'login' do 
    let(:user) { FactoryGirl.create(:user, login: 'bob') } 
    it 'must be unique' do 
    _user1 = user 
    user2 = User.new login: 'bob' 
    expect(user2.valid?).to be_false 
    end 
end 

Qui stiamo indicando che la nostra user Memoizzazione aiuto ha un effetto collaterale e restituisce qualcosa, ma non ci interessa a proposito.Si potrebbe anche saltare l'assegnazione del tutto, ma vedere una nuda user su una riga da solo sembra strano e non rivela l'intenzione nel modo più chiaro:

describe 'login' do 
    let(:user) { FactoryGirl.create(:user, login: 'bob') } 
    it 'must be unique' do 
    user 
    user2 = User.new login: 'bob' 
    expect(user2.valid?).to be_false 
    end 
end 

Altri scenari sono ignorando i valori di iteratori, o l'override un metodo in cui si desidera mantenere la firma del metodo originale ma non si preoccupa di alcuni valori:

def greet(name, _title) 
    puts "Hi, #{name}!" 
end