norme e convenzioni di codifica per i linguaggi di programmazione come Java sono progettati per migliorare la qualità e l'affidabilità delle applicazioni costruite utilizzando queste lingue . Progetti Java sono spesso di grandi dimensioni , con diversi componenti lavorato per un certo numero di sviluppatori differenti . Avere un insieme condiviso di pratiche significa che gli sviluppatori possono lavorare con il codice di tutti in modo più efficace , in quanto il codice è più chiaro e più facile da leggere . Naming
convenzioni Java dettano alcune regole per nominare gli elementi del programma , quali variabili , classi , oggetti , i pacchetti e le interfacce tra gli altri. CamelCase è utilizzato nella maggior parte dei casi, come negli esempi seguenti :
//i nomi delle classi iniziare maiuscolo
classe MyClass
//variabili iniziano minuscole
oggetto anObject
In generale , un nome significativo, ad esempio, " contatore " , invece di "c " in modo che le persone ( compreso te ) che leggono il codice in grado di capire più facilmente.
Rientro
indentazione è uno degli elementi chiave di programmazione che rende il codice più facile da leggere . Indentazione dovrebbe generalmente riflettono le strutture logiche in un programma , e consente di identificare le informazioni a colpo d'occhio , per esempio, l'ambito delle variabili . Convenzioni Java detta anche dove le interruzioni devono avvenire entro le linee avvolte di codice , con le interruzioni di riga privilegiate che si verificano dopo le virgole e prima gli operatori , come segue :
aMethod ( parameterOne , parameterTwo , Stati
parameterThree ) ;
int answer = itemOne + itemTwo
+ itemThree ; .
Le seconde linee in questi casi dovrebbero idealmente venire dopo otto spazi
Commenti
L' uso di commenti rende più facile tutto il codice per lavorare con , in particolare se gli algoritmi lunghi o complessi sono coinvolti . Commenti del codice secondo le convenzioni Java dovrebbero essere inclusi prima delle dichiarazioni di variabili chiave , metodi , classi e le strutture lunghe , così come all'interno di tutti questi. Usare entrambe le osservazioni singole e multi - linea , che si verificano sulle proprie linee o alla fine di righe di codice :
/*
* Questo è un commento in un blocco
* /Eventi
//Questa è una singola riga di commento
int counter = 0; //Questo è ulteriori informazioni sulla riga di codice
Documentazione < br >
Si crea documentazione Java principalmente utilizzando l'impianto Javadoc , che genera i documenti HTML risorse più Java standard e utilizzare applicazioni , tra cui il linguaggio stesso . È possibile creare contenuti Javadoc nel codice sorgente utilizzando commenti Javadoc :
/**
* Questo è un commento Javadoc
* - notare il doppio asterisco per iniziare
< p > * /
Quando gli sviluppatori stanno lavorando con il codice che è stato sviluppato da qualcun altro , il loro primo punto di riferimento è spesso il Javadoc , in quanto fornisce una panoramica della risorsa senza dover leggere effettivamente il codice stesso.
design Program
Ci sono molte convenzioni e le norme per i dettagli di implementazione all'interno di programmi Java . Un esempio è l'approccio a fornire l'accesso alle variabili di una classe da codice esterno . (Vedi riferimenti 4 ) In generale si consiglia di mantenere le variabili di classe private , e di fornire l'accesso ad essi tramite metodi pubblici. Ad esempio, se una classe ha una variabile di istanza di stringa di testo denominato " someData " potrebbe avere un metodo che fornisce l'accesso ad esso da un altro punto dell'applicazione :
pubblico stringa getData ( ) {return someData ; }