Nwlapcug.com


Java Coding Standards

Java Coding Standards


Codifica standard e convenzioni per linguaggi di programmazione come Java sono progettati per migliorare la qualità e l'affidabilità delle applicazioni create mediante tali linguaggi. Progetti Java sono spesso grandi, con vari componenti su cui ha lavorati un numero di diversi sviluppatori. Avendo un insieme condiviso di mezzi di pratiche che gli sviluppatori possono lavorare con il codice di tutti in modo più efficace, in quanto il codice è più chiara e più facile da leggere.

Denominazione

Alcune regole per la denominazione degli elementi di programma quali variabili, classi, oggetti, pacchetti e interfacce tra gli altri in base alle convenzioni di Java. CamelCase è utilizzato nella maggior parte dei casi come negli esempi seguenti:

I nomi di classe iniziare maiuscoli

Classe MyClass

le variabili iniziano minuscole

Oggetto anObject

In generale, utilizzare nomi significativi, ad esempio "contatore" invece di "c" in modo che persone (compresi se stessi) legge il codice può capire più facilmente.

Rientri

Rientro è uno degli elementi chiave nella programmazione che rende il codice più facile da leggere. Rientro in generale dovrebbe riflettere le strutture logiche in un programma e aiuta a identificare le informazioni in un colpo d'occhio; ad esempio, l'ambito delle variabili. In base alle convenzioni Java anche dove le interruzioni devono avvenire all'interno di righe di codice, con le interruzioni di riga preferito che si verificano dopo una virgola e prima gli operatori, come segue:

aMethod (parameterOne, parameterTwo,

parameterThree);

risposta di int = itemOne + itemTwo

itemThree;

Le seconde linee in questi casi idealmente dovrebbero venire dopo otto spazi.

Commenti

L'utilizzo di commenti rende tutto il codice più facile da lavorare, soprattutto se sono coinvolti gli algoritmi complessi o lunghi. Commenti di codice in base alle convenzioni Java dovrebbero essere incluso prima di dichiarazioni di variabili chiave, metodi, classi e strutture di lunga durate, nonché all'interno di tutti questi. Utilizzare i commenti sia singoli e multi-linea, che si verificano sulle proprie linee o alla fine di righe di codice:

/*

Questo è un commento in un blocco

*/

Si tratta di un commento a riga singola

int contatore = 0; Si tratta di ulteriori informazioni sulla riga di codice

Documentazione

Si crea la documentazione Java principalmente utilizzando la struttura di Javadoc, che genera le risorse HTML documenti più standard Java e applicazioni utilizzano, tra cui il linguaggio stesso. È possibile creare Javadoc contenuti all'interno del codice sorgente utilizzando commenti Javadoc:

/**

Si tratta di un commento Javadoc

Nota il doppio asterisco per iniziare

*/

Quando gli sviluppatori stanno lavorando con il codice che è stato sviluppato da qualcun altro, loro primo punto di riferimento è spesso il Javadoc, poiché fornisce una panoramica della risorsa senza dover effettivamente leggere il codice stesso.

Progettazione del programma

Ci sono molte convenzioni e standard per i dettagli di implementazione all'interno di programmi Java. Un esempio è l'approccio a fornire l'accesso alle variabili in una classe da codice esterno. (Vedere riferimenti 4) In genere è consigliabile mantenere le variabili di classe private e fornire l'accesso a loro utilizzando i metodi pubblici. Ad esempio, se una classe è una variabile di istanza string di testo denominata "someData" potrebbe avere un metodo che fornisce accesso ad esso da altrove nell'applicazione:

public String string GetData () {return someData;}