Convenzioni di denominazione

Download java eBook

Esempio

Nomi dei pacchetti

  • I nomi dei pacchetti devono essere tutti in minuscolo senza caratteri di sottolineatura o altri caratteri speciali.
  • I nomi dei pacchetti iniziano con la parte dell'autorità invertita dell'indirizzo Web della società dello sviluppatore. Questa parte può essere seguita da una sottostruttura del pacchetto dipendente dal progetto / struttura.
  • Non usare la forma plurale. Seguire la convenzione dell'API standard che utilizza ad esempio java.lang.annotation e non java.lang.annotations .
  • Esempi: com.yourcompany.widget.button , com.yourcompany.core.api

Nomi di classe, interfaccia e enum

  • I nomi di classe e enum in genere dovrebbero essere nomi.
  • I nomi delle interfacce dovrebbero in genere essere nomi o aggettivi che terminano con ... in grado.
  • Usa maiuscole e minuscole con la prima lettera di ciascuna parola in maiuscolo (es. CamelCase ).
  • Abbina l'espressione regolare ^[AZ][a-zA-Z0-9]*$ .
  • Usa parole intere ed evita di usare le abbreviazioni a meno che l'abbreviazione non sia più usata della forma lunga.
  • Formatta un'abbreviazione come parola se fa parte di un nome di classe più lungo.
  • Esempi: ArrayList , BigInteger , ArrayIndexOutOfBoundsException , Iterable .

Nomi dei metodi

I nomi dei metodi dovrebbero in genere essere verbi o altre descrizioni di azioni

  • Dovrebbero corrispondere all'espressione regolare ^[az][a-zA-Z0-9]*$ .
  • Usa maiuscole e minuscole con la prima lettera in minuscolo.
  • Esempi: toString , hashCode

variabili

I nomi delle variabili dovrebbero essere in maiuscolo con la prima lettera in minuscolo

  • Abbina l'espressione regolare ^[az][a-zA-Z0-9]*$
  • Ulteriore raccomandazione: variabili
  • Esempi: elements , currentIndex

Digita le variabili

Per i casi semplici in cui ci sono poche variabili di tipo coinvolte usa una sola lettera maiuscola.

  • Abbina l'espressione regolare ^[AZ][0-9]?$
  • Se una lettera è più descrittiva di un'altra (come K e V per le chiavi e i valori nelle mappe o R per un tipo di ritorno di funzione), usa quella, altrimenti usa T
  • Per i casi complessi in cui le variabili di tipo a lettera singola diventano confuse, utilizzare nomi più lunghi scritti in lettere maiuscole e utilizzare il carattere di sottolineatura ( _ ) per separare le parole.
  • Esempi: T , V , SRC_VERTEX

costanti

Le costanti (campi static final cui contenuto è immutabile, per regole linguistiche o per convenzione) devono essere denominati con tutte le lettere maiuscole e il carattere di sottolineatura ( _ ) per separare le parole.

  • Abbina l'espressione regolare ^[AZ][A-Z0-9]*(_[A-Z0-9]+)*$
  • Esempi: BUFFER_SIZE , MAX_LEVEL

Altre linee guida sulla denominazione

  • Evitare metodi di occultamento / ombreggiamento, variabili e variabili di tipo negli ambiti esterni.
  • Lascia che la verbosità del nome sia correlata alla dimensione dell'ambito. (Ad esempio, utilizzare nomi descrittivi per campi di classi grandi e nomi brevi per variabili locali di breve durata.)
  • Quando si nominano membri statici pubblici, lasciare che l'identificatore sia auto-descrittivo se si ritiene che verranno importati staticamente.
  • Ulteriori letture: Naming Section (nella guida ufficiale allo stile Java)

Fonte: linee guida stile Java da Oracle

Stats

Contributors: 11
2016-08-09
Autorizzato sotto: CC-BY-SA

Non affiliato con Stack Overflow
Rip Tutorial: info@zzzprojects.com

Scarica eBook