Spesso nel condividere il proprio codice con altri sviluppatori crea confusione a causa dei differenti stili di scrittura. Ecco alcune linee guida per evitare questo cercando di utilizzare un formato il più possibile uniforme per rendere più semplice la lettura del proprio codice anche ad altri sviluppatori.
Ovviamente non tutto quello che è scritto qui deve essere seguito alla lettere, ma l’importante è fare delle proprie scelte ed essere consistenti con queste al fine di agevolare la lettura del proprio codice.
Definizioni
- TitleCase
ovvero tutte le parole che compongono il termine sono scritte con la prima lettera maiuscola - camelCase
ovvero la prima parola che compone il termine inizia con la lettera minuscola, le altre con la maiuscola
Costanti
Le costanti dovrebbero iniziare on k minuscolo seguito dal termine in TitleCase
Const kNumeroUtentiMassimo = 5 |
Variabili locali
Si dovrebbero evitare le abbreviazioni e utilizzare dei nomi completi (l’autocompletamento aiuta in questo), si possono usare variabili dal nome breve per i contatori o le variabili utilizzate nei cicli For e Loop, si dovrebbe usare il camelCase
Dim nomeCliente as Text |
Vettori
Dovrebbero essere con un nome al plurale
Dim clienti() as Cliente |
Proprietà
Dovrebbero essere in TitleCase e nel caso di proprietà computate la proprietà base dovrebbe iniziare con m
NomeCliente |
Metodi
Il nome del metodo dovrebbe essere in TitleCase e i nomi dei parametri dovrebbero essere in camelCase
SalvaCliente(nomeCliente as Text) |
Controlli
Utilizzare il TitleCase con un suffisso (o un prefisso, ma l’importante è essere coerenti) che ne indichi il tipo
ClientiList |
Classi (Tipi)
Utilizzare il TitleCase e nel caso di sottoclasse di un controllo indicare in controllo base
ClientiListBox |
Finestre
Utilizzare il TitleCase seguito da Window (o anche solo un prefisso w)
ClientiWindow |
wClienti |
Interfacce
Utilizzare il TitleCase e con il suffisso Interface
ClienteInterface |
Formattazione
- I tipi di dati dovrebbero essere in TitleCase
Dim n as Integer
- Le parole chiave dovrebbero essere in TitleCase
For Each c as Cliente in clienti
- Inserire degli spazi tra gli argomenti dei metodi
SalvaCliente(nome, indirizzo, luogo)
- Non inserire spazi prima o dopo le parentesi
- I metodi chiamati senza parametri non dovrebbero avere le parentesi
RegistraCliente
- Lasciare delle righe vuote nel codice per rendere migliore la leggibilità
- I comandi SQL dovrebbero essere scritti in MAIUSCOLO
SELECT * FROM squadre WHERE serie='A'
Codice
- Dichiara le variabili locali vicino a dove inizi ad utilizzarle e con una variabile per riga
- I metodi non utilizzati al di fuori di una classe o di un modulo dovrebbero essere dichiarati Privati
- Evita di avere più punti di Return dai metodi o se proprio devi averli rendili chiari con commenti ed uso delle righe vuote
- Quando possibile utilizza il tipo Text piuttosto che il tipo String. Il metodo String.ToText permette di convertire valori di tipo String in valori di tipo Text
- Utilizza quando possibile la notazione con il punto per i metodi invece che quelli globali
Dim lunghezza As Integer = clienteNome.Len
- Non utilizzare Me quando intendi utilizzare Self (tipico nelle Window) In genere evitare di utilizzare Me al di fuori degli eventi
//All'interno dell'action di un pulsante Me.visible=False //Nasconde il pulsante Self.visible=False //Nasconde la finestra
- Limita l’uso delle variabili globali
- Utilizza i metodi e le proprietà condivise piuttosto che metodi e proprietà globali in moduli
- Se possibile rendi le classi nei moduli, le proprietà e i metodi privati. Rendi pubblici solo quelli che devono essere chiamati dall’esterno.