2016-04-08 28 views
6

Trovo che io sia spesso un po 'incoerente nelle convenzioni di denominazione delle variabili, e mi chiedo solo quali persone considerano l'approccio migliore. La convenzione specifica di cui sto parlando è quando una variabile deve essere descritta da un sostantivo e da un aggettivo, e se l'aggettivo dovrebbe venire prima o dopo il nome. La domanda è generale in tutti i linguaggi di programmazione, anche se personalmente uso C++ e Python.I nomi delle variabili dovrebbero avere aggettivi prima o dopo il nome?

Ad esempio, si consideri la scrittura di una GUI, che ha due pulsanti; uno a destra e uno a sinistra. Ora ho bisogno di creare due variabili per memorizzarle. Un'opzione sarebbe avere l'aggettivo prima del nome e chiamarli left_button e right_button. L'altra opzione sarebbe quella di avere l'aggettivo dopo il nome e chiamarli button_left e button_right. Con il primo caso, ha più senso quando si legge a voce alta, perché in inglese si posiziona sempre l'aggettivo prima del nome. Tuttavia, con il secondo caso, aiuta a strutturare i dati semanticamente, poiché button rivela la maggior parte delle informazioni sulla variabile e left o right è un'informazione supplementare.

Quindi cosa ne pensi? L'aggettivo dovrebbe essere prima del o dopo il il sostantivo? O è interamente soggettivo?

+1

Sono interessato a sentire cosa gli altri hanno da dire su questo argomento ... FWIW, tendo a pensare che la coerenza sia più importante di una convenzione; il caso peggiore sarebbe un 'left_button' vicino a un' button_right' ... –

+1

Personalmente, tendo ad usare l'aggettivo dopo il nome, e, g. 'Button_left'. Se poi volessi aggiungere un attributo di questo, lo aggiungerei alla fine, ad es. 'Button_left_width'. Sembra strano dirlo ad alta voce, ma è più comprensibile durante la lettura del codice. – Karnivaurus

+1

@Karnivaurus Io uso anche l'aggettivo dopo il nome perché con inteli senso è più facile trovare uno corretto specialmente quando sono molti. Digitando il pulsante ottieni l'elenco delle variabili filtrate e puoi vedere quali pulsanti hai dichiarato. Sto usando Qt-Creator. – Radek

risposta

2

Penso che scrivere l'aggettivo prima del nome sia la cosa più comune. Ma se ci pensi per un secondo, scriverlo dopo il nome è più facile quando leggi il tuo codice. L'aggettivo può essere facilmente visto come un attributo del sostantivo. In un modo logico di pensare, questo è il modo migliore secondo me.

4

Provo ad utilizzare noun_adj perché è conforme a ciò che utilizzo per le funzioni. Quando scrivo funzioni tendo a usare verb_noun_adj, per esempio:

def get_button_id(): 
    """Get id property of button object.""" 
    pass 

Questa legge per me un po 'più chiaramente che get_id_button perché non è del tutto chiaro che cosa state ottenendo qui: E' sempre la button.id o sta ottenendo un pulsante chiamato 'id' o forse anche qualcos'altro? A meno che non si espanda il nome per essere un po 'più chiaro, come get_id_of_button che potrebbe essere un po' troppo prolisso per te.

Probabilmente c'è un argomento altrettanto valido contro quello che sto facendo qui, ma almeno sono coerente nella mia follia?

+0

Follia? Intendevi la Sanità? Ti ho messo al corrente! ;) –