Linee guida nella scrittura di codice #02: Nomi di membri e tipi
Giovedì 18 Ottobre 2007 - 08:21
di Gianni Malanga
Al pari delle classi e delle interfacce è molto importante assegnare i giusti nomi a metodi, proprietà, eventi, campi pubblici e privati.
Per quanto riguarda il nome dei metodi è opportuno utilizzare sempre verbi in quanto i metodi per definizione agiscono sui dati e quindi compiono un’azione che se opportunamente sintetizzata nel nome permette di comprendere immediatamente il funzionamento del metodo stesso.
I nomi delle proprietà dovrebbero essere dei nomi o aggettivi in quanto le proprietà contengono dati e quindi un nome o un aggettivo aiuta a comprendere il significato del dato esposto dalla proprietà. Evitare di nominare una proprietà con nomi già utilizzati per identificare i metodi Get. Ad esempio evitare di chiamare una proprietà Cliente se già esiste un metodo GetCliente.
È buona norma assegnare alle proprietà di tipo bool nomi del tipo: CanRead, CanWrite, CantRead, IsOpen, HasChild, etc.
Nel caso particolare in cui una proprietà esponga un tipo enum può essere assegnato alla proprietà lo stesso nome dell’enum. Ad esempio una proprietà che espone un valore dell’enum RowState può anch’essa essere chiamata RowState.
Anche per il nome degli eventi è opportuno utilizzare verbi con l’aggiunta del tempo del verbo che indicherà il momento dell’evento (prima o dopo l’azione). Ad esempio assegnare il nome Closing ad un evento generato prima della chiusura di un file e Closed a quello generato immediatamente dopo la chiusura dello stesso. Evitare quindi di utilizzare i prefissi Before o After per indicare il momento temporale dell’evento.
I nomi dei campi pubblici e privati devono seguire la convenzione Pascal case e devono essere nomi o locuzioni nominali. Evitare l’utilizzo di prefissi per i nomi dei campi (ad esempio i prefissi per indicarne il tipo quali: s_, n_, b_, …).
Categoria: Microsoft Dev | Permalink
Commenti
1
Solo per dire che questo tipo di lettura aiuta molto. Sono convinto che abbiamo sempre bisogno tutti di una rinfrescata sul modo di scrivere codice e su regole di buon senso anche se non scritte! Buon lavoro e grazie!
2
Evitare l’utilizzo di prefissi per i nomi dei campi (ad esempio i prefissi per indicarne il tipo quali: s_, n_, b_, …)
Perché?
Una delle cose funzionali che ho imparato è stata proprio la “notazione ungherese”…# - postato da P&M - 18 Ottobre 2007 - 14:03
3
Come ho scritto nel primo post, queste più che regole sono “consigli”. Ognuna di esse è il frutto dell’esperienza di sviluppo di Microsoft e hanno raggiunto lo status di Guidelines evidentemente perchè sono risultate utili nel corso del tempo. Per rispondere alla tua domanda probabilmente questa regola deriva dal fatto che in .NET esiste già un modo per capire il tipo di una variabile, non come invece accadeva nei vecchi linguaggi tipo il BCPL da cui questa notazione ha preso inizio. E’ quindi superfluo specificarlo nel nome.
# - postato da Gianni Malanga - 18 Ottobre 2007 - 14:17