Alcune semplici regole aiutano a scrivere codice comprensibile a tutti (noi compresi).
definizioni
- camelCase
- lo scrivere più nomi attaccati mettendo in maiuscola soltanto l'iniziale di ogni parola
- indentazione
- il modo di scrivere parti di codice spostandole verso destra/sinistra in maniera sensata
formattazione
sulla sinistra con questi colori troverai i modi corretti di formattare il codice
sulla destra con questi colori troverai i modi errati di formattare il codice (non sono errori di sintassi ma complicano la lettura)
i condizionali e i cicli devono avere il corpo racchiuso tra graffe
if( x == 10){
m=9;
}
if( x == 10) m=9;
la graffa viene aperta alla destra dell'istruzione a cui attiene (e non a capo)
if( x == 10){
m=9;
}
if( x == 10)
{
m=9;
}
la graffa chiusa sta sulla stessa colonna del primo carattere dell'istruzione aperta a cui attiene
if( x == 10){
m=9;
}
if( x == 10)
{
m=9;}
eccezioni alla regola precedente sono l'else }else{ e il do-while }while(...)
if( x == 10){
m=9;
}else{
m=10;
}
if( x == 10){
m=9;
}
else
{
m=10;
}
il nomi delle variabili e dei metodi iniziano con la minuscola e procedono in camelCase
latoQuadrato nomeProprietarioAutomobile calcolaArea()
LatoQuadrato nome_proprietario_automobile CALCOLAarea()
i nomi delle variabili devono indicare cosa contengono (non il valore o nomi non significativi)
latoQuadrato areaQuadrato perimetroQuadrato
n1 n2 sedici
il nomi delle classi iniziano con la Maiuscola e procedono in camelCase
Quadrato RuotaAutomobile
quadrato Ruota_Automobile
il nomi dei pacchetti sono scritti in tutto minuscolo
org.canili.quecia.bracchetti
org.canili.quecia.Bracchetti
org.canili.quecia.bracchettiAlti
quando una riga termina con una graffa aperta la successiva rientra di un tab (solitamente un tab equivale a 2-3-4 spazi, è possibile impostare gli ambienti di sviluppo in modo che inseriscano un certo numero di spazi al posto dei tab)
if( x == 10){
m=9;
}
if( x == 10){
m=9;
}
if( x == 10){
m=9;
}
if( x == 10){
m=9;
}
lecito lasciare una riga vuota (al massimo due) per separare zone diverse di programma
int x;
casellaTesto.setText("ciao");
int x;
casellaTesto.setText("ciao");