Software Planet - Specifiche Sun: convenzioni per la codifica dei programmi

Specifiche Sun

Spazio bianco e Convenzioni di naming

8. Spazio bianco

8.1. Linee bianche
Le linee bianche aumentano la leggibilità risaltando le sezioni di codice che sono logicamente correlate.

Due linee bianche dovrebbero essere sempre usate nelle seguenti circostanze:

Fra sezioni di un file sorgente
Fra definizioni di classe e interfaccia

Una linea bianca dovrebbe essere sempre usata nelle seguenti circostanze:

Fra metodi
Fra le variabili locali in un metodo e la sua prima istruzione
Prima di un commento di blocco (vedi sez. 5.1.1) o a singola linea (vedi sez. 5.1.2)
Fra sezioni logiche all’interno di un metodo per migliorarne la leggibilità

8.2. Spazi bianchi
Spazi bianchi dovrebbero essere usati nelle seguenti circostanze:

Una parola chiave seguita da una parentesi dovrebbe essere separata da uno spazio. Ad esempio:

    while (true) {
        ...
    }

Notare che uno spazio bianco non dovrebbe essere usato fra il nome di un metodo e le sue parentesi d’apertura. Questo aiuta a distinguere le parole chiave dalle chiamate di metodo.

Uno spazio bianco dovrebbe essere interposto dopo le virgole nelle liste di argomenti.
Tutti gli operatori binari eccetto . dovrebbero essere separati dai loro operandi tramite spazi. Gli spazi bianchi non dovrebbero mai separare gli operatori unari come l’operatore meno, l’incremento (“++”), e il decremento (“--”) dai loro operandi. Ad esempio:

a += c + d;
a = (a + b) / (c * d);
while (d++ = s++) {
n++;
}
prints("la dimensione e’ " + foo + "\n");

Le espressioni in un’istruzione for dovrebbero essere separate da spazi bianchi. Ad esempio:

for (espr1; espr2; espr3)
I cast dovrebbero essere seguiti da uno spazio bianco. Ad esempio:

mioMetodo((byte) aNum, (Object) x);
mioMetodo((int) (cp + 5), ((int) (i + 3)) + 1);

9. Convenzioni di naming
Le convenzioni di naming rendono i programmi più comprensibili, poiché ne semplificano la leggibilità.
Inoltre possono dare informazioni circa la funzione dell’identificatore – ad es. se è una costante, un package o una classe – che può essere d’aiuto nella comprensione del codice.

Tipo di identificatore	Regole di naming	Esempi
Package	Il prefisso di un nome di package unico è sempre scritto interamente in lettere ASCII minuscole e dovrebbe essere un nome di dominio di massimo livello come com, edu, gov, mil, net, org, o uno dei codici inglesi a due lettere che identificano delle nazioni come specificato nello standard ISO 3166, 1981. I componenti seguenti del nome del package variano in accordo con le convenzioni di naming interne proprie dell’organizzazione che lo ha creato. Tali convenzioni potrebbero specificare che certi componenti del nome di directory sono nomi di divisione, dipartimento, progetto, macchina, o login.	com.sun.eng com.apple.quicktime.v2 edu.cmu.cs.bovik.cheese

Tipo di identificatore	Regole di naming	Esempi
Classi	I nomi di classe dovrebbero essere sostantivi, con lettere sia maiuscole che minuscole e con la prima lettera di ogni parola interna maiuscola. Cercare di rendere i nomi di classe semplici e descrittivi. Usare parole intere – evitare acronimi e abbreviazioni (a meno che l’abbreviazione sia più usata della forma lunga, come URL o HTML).	class Raster; class ImageSprite;
Interfacce	I nomi di interfaccia dovrebbero essere scritti come i nomi di classe.	interface RasterDelegate; interface Storing;
Metodi	I metodi dovrebbero essere verbi, in lettere sia maiuscole che minuscole con la prima lettera minuscola e la prima lettera di ogni parola interna maiuscola.	corri(); corriVeloce(); getBackground();

Tipo di identificatore	Regole di naming	Esempi
Variabili	Tutte le variabili, le costanti e le istanze di classe sono scritte in lettere sia maiuscole che minuscole con la prima lettera minuscola. Le parole interne iniziano con una lettera maiuscola. I nomi di variabile non devono iniziare con caratteri di underscore _ o di segno di dollaro $, sebbene siano entrambi permessi. I nomi di variabile devono essere corti ma significativi. La scelta di un nome di variabile deve essere mnemonica — cioè pensata per indicare ad un casuale osservatore l’utilizzo che ne viene fatto. I nomi di variabile di un solo carattere dovrebbero essere evitati, eccetto per variabili di comodo. Nomi comuni per variabili temporanee sono i, j, k, m, ed n per gli interi; c, d, ed e per i caratteri.	int i; char c; float totaleAmpiezza;
Costanti	I nomi delle variabili dichiarate come costanti di classe e delle costanti ANSI dovrebbero essere scritte in lettere tutte maiuscole con le parole separate da underscore (“_”). (Le costanti ANSI dovrebbero essere evitate, per facilità di debugging.)	static final int MIN_AMPIEZZA = 4; static final int MAX_AMPIEZZA = 999; static final int GET_THE_CPU = 1;

Torna all'indice Generale del corso di Specifiche Sun di Software Planet