Esistono convenzioni per l'ordinazione dei metodi Java?

Question

Ho una classe di grandi dimensioni (circa 40 metodi) che fa parte di un pacchetto che invierò come corso del corso. Attualmente, i metodi sono piuttosto confusi in termini di utilità pubblica/privata ecc. E voglio ordinarli in modo ragionevole. C'è un modo standard per farlo? Per esempio. normalmente i campi sono elencati prima dei metodi, i costruttori sono elencati prima di altri metodi e i getter/setter durano; per quanto riguarda i restanti metodi?

Answer 1

Alcune convenzioni elencano prima tutti i metodi pubblici e poi tutti quelli privati. Ciò significa che è facile separare l'API dall'implementazione, anche quando non è coinvolta un'interfaccia, se si capisce cosa intendo.

Un'altra idea è quella di raggruppare i metodi correlati insieme: ciò semplifica l'individuazione delle giunzioni in cui è possibile suddividere la classe esistente esistente in diverse più piccole e più mirate.

Answer 2

40 metodi in una singola classe sono un po 'troppo.

Avrebbe senso spostare alcune delle funzionalità in altre classi, opportunamente denominate. Quindi è molto più facile dare un senso.

Quando ne hai di meno, è molto più facile elencarli in un ordine di lettura naturale. Un paradigma frequente è quello di elencare le cose prima del o dopo il di cui hai bisogno, nell'ordine in cui ne hai bisogno.

Questo di solito significa che main() va sopra o sotto.

Answer 3

Si sta utilizzando Eclipse? Se è così, rimarrò con l'ordinamento dei membri predefinito, perché probabilmente è più familiare a chiunque legga il tuo codice (anche se non è il mio preferito).

Answer 4

La mia "convenzione": statica prima dell'istanza, pubblica prima privato, costruttore prima dei metodi, ma metodo principale in basso (se presente).

Answer 5

Non sono sicuro che ci sia uno standard universalmente accettato, ma le mie preferenze personali sono;

• costruttori primi
• metodi statici prossimi, se v'è un metodo main, sempre prima di altri metodi statici
• metodi non statici prossimo, di solito in ordine di importanza del metodo seguito mediante qualsiasi metodo che chiamate. Ciò significa che i metodi pubblici che chiamano altri metodi di classe apparire verso i metodi migliori e privati ​​che richiedono altri metodi di solito finiscono verso le
• metodi standard inferiori come toString, equals e hashcode prossimi
• getter e setter hanno un posto speciale Right Reserved in fondo alla classe

Answer 6

il legame più precisa di «convenzioni Codice»: «Class and Interface Declarations»

Answer 7

1. Class (variabili statiche): prima le variabili di classe pubblica, quindi la protetta e quindi la privata.

2. Variabili di istanza: prima pubblica, quindi protetta, quindi privata.

3. Costruttori

4. Metodi: Questi metodi devono essere raggruppate per funzionalità piuttosto che dalla portata o l'accessibilità. Ad esempio, un metodo di classe privata può trovarsi tra due metodi di istanza pubblici. L'obiettivo è di rendere la lettura e la comprensione del codice più semplice.

Fonte: http://www.oracle.com/technetwork/java/codeconventions-141855.html

Answer 8

Inoltre, Eclipse offre la possibilità di ordinare i membri della classe per voi, se li per qualche motivo mischiato:

Aprire il file di classe, il via alla "Fonte "nel menu principale e selezionare" Ordina membri ".

presi da qui: Sorting methods in Eclipse