Java Πρότυπα Κωδικοποίησης

Τα Πρότυπα κωδικοποίησης και συμβάσεις για τις γλώσσες προγραμματισμού όπως Java σχεδιαστεί για να βελτιώσουν την ποιότητα και την αξιοπιστία των εφαρμογών κατασκευάζονται με αυτές τις γλώσσες . Σχέδια Java είναι συχνά μεγάλες , με ποικίλες συνιστώσες εργάστηκε με έναν αριθμό διαφορετικών προγραμματιστές. Έχοντας ένα κοινό σύνολο πρακτικών σημαίνει ότι οι προγραμματιστές μπορούν να εργάζονται με τον κωδικό του καθενός πιο αποτελεσματικά , όπως ο κώδικας είναι σαφέστερη και πιο εύκολο να το διαβάσετε. Ονοματοδοσία
Η

συμβάσεις Java υπαγορεύουν ορισμένους κανόνες για την ονομασία στοιχεία του προγράμματος όπως οι μεταβλητές , κλάσεις, αντικείμενα , συσκευασίες και διεπαφές μεταξύ άλλων. CamelCase χρησιμοποιείται στις περισσότερες περιπτώσεις, όπως στα ακόλουθα παραδείγματα :

//Κλάση Ονόματα ξεκινήσει κεφαλαία

Class MyClass

//μεταβλητές ξεκινήσει πεζά

Αντικείμενο AnObject

Σε γενικές γραμμές , η χρήση νόημα ονόματα , για παράδειγμα, " counter" αντί του " c" , έτσι ώστε οι άνθρωποι ( συμπεριλαμβανομένου του εαυτού σας ) διαβάζοντας τον κωδικό σας μπορούν να το καταλάβουν πιο εύκολα .
εικόνων εσοχή
Η

εσοχές είναι ένα από τα βασικά στοιχεία προγραμματισμού που καθιστά κώδικα πιο ευανάγνωστο . Εσοχές θα πρέπει να αντανακλούν εν γένει τις λογικές δομές σε ένα πρόγραμμα , και βοηθά στον εντοπισμό των πληροφοριών με μια ματιά ? Για παράδειγμα , το πεδίο εφαρμογής των μεταβλητών . Συμβάσεις Java υπαγορεύει , επίσης, όπου τα διαλείμματα πρέπει να γίνεται εντός τυλιγμένο γραμμές κώδικα , με τα διαλείμματα προτιμώμενη γραμμή που συμβαίνουν μετά κόμματα και πριν από φορείς , ως εξής :

aMethod ( parameterOne , parameterTwo , πώληση

parameterThree ) ?

int answer = itemOne + itemTwo

+ itemThree ?

το δεύτερο γραμμές σε αυτές τις περιπτώσεις θα πρέπει ιδανικά να έρθει μετά από οκτώ θέσεις
εικόνων <. br > σχόλια
Η

Η χρήση των παρατηρήσεων που κάνει όλος ο κώδικας πιο εύκολο να εργαστεί με , ειδικά αν είναι μεγάλη ή πολύπλοκων αλγορίθμων που εμπλέκονται . Δείτε τα σχόλια του κώδικα σύμφωνα με τις συμβάσεις Java θα πρέπει να συμπεριληφθούν πριν από τις δηλώσεις των βασικών μεταβλητών , μέθοδοι, τάξεις και κάθε μακρά δομές , καθώς και μέσα σε όλα αυτά . Χρησιμοποιήστε και τα δύο μονά και πολλαπλών γραμμών σχόλια , που συμβαίνουν στις δικές τους γραμμές ή στο τέλος των γραμμών κώδικα :

/*

* Αυτό είναι ένα σχόλιο σε ένα μπλοκ

* /

//Αυτό είναι ένα σχόλιο ενιαία γραμμή

int μετρητή = 0 ? //Αυτό είναι πρόσθετες πληροφορίες σχετικά με τη γραμμή του κώδικα
εικόνων Τεκμηρίωση

Μπορείτε να δημιουργήσετε Java τεκμηρίωση κυρίως με τη χρήση του μηχανισμού Javadoc , η οποία παράγει τα έγγραφα HTML πιο τυπική πόρους και εφαρμογές Java χρησιμοποιούν , συμπεριλαμβανομένης της ίδιας της γλώσσας . Μπορείτε να δημιουργήσετε το περιεχόμενο Javadoc εντός πηγαίο κώδικα χρησιμοποιώντας σχόλια Javadoc :

/**

* Αυτό είναι ένα σχόλιο Javadoc

* - σημειώστε το διπλό αστερίσκο για να ξεκινήσει

* /

Όταν οι προγραμματιστές εργάζονται με κώδικα που αναπτύχθηκε από κάποιον άλλο , το πρώτο σημείο αναφοράς τους είναι συχνά η Javadoc , καθώς παρέχει μια επισκόπηση των πόρων χωρίς να χρειάζεται να διαβάσει πραγματικά ίδιου του κώδικα .
εικόνων Σχεδιασμός Προγράμματος
Η

Υπάρχουν πολλές συμβάσεις και τα πρότυπα για τις λεπτομέρειες της εφαρμογής στο πλαίσιο των προγραμμάτων Java . Ένα τέτοιο παράδειγμα είναι η προσέγγιση για την παροχή πρόσβασης στις μεταβλητές σε μια κατηγορία από το εξωτερικό κωδικό . ( Βλ. Αναφορές 4 ) Είναι γενικά συνιστάται να κρατήσει μεταβλητές κλάσης ιδιωτικό , και θα παρέχει πρόσβαση σε αυτούς που χρησιμοποιούν τις δημόσιες μεθόδους . Για παράδειγμα , αν μια κλάση έχει μια μεταβλητή παράδειγμα συμβολοσειράς κειμένου που ονομάζεται " someData " θα μπορούσε να έχει μια μέθοδο που παρέχει πρόσβαση σε αυτό από αλλού στην εφαρμογή :

δημόσια εγχόρδων GetData ( ) {επιστροφή someData ? }


εικόνων