Coding Standards und Konventionen für Programmiersprachen wie Java sind entworfen, um die Qualität und Zuverlässigkeit von Anwendungen, die mit diesen Sprachen zu verbessern. Java-Projekte sind oft groß , mit unterschiedlichen Komponenten gearbeitet durch eine Reihe von verschiedenen Entwicklern . Mit einer gemeinsamen Reihe von Praktiken bedeutet, dass Entwickler können mit jeder Code effektiver arbeiten , da der Code übersichtlicher und leichter zu lesen. Benennen
Java Konventionen diktieren bestimmte Regeln für die Benennung von Programm-Elemente wie Variablen, Klassen, Objekte , Pakete und Schnittstellen unter anderem. CamelCase wird in den meisten Fällen wie in den folgenden Beispielen verwendet:
//Class Names starten Großbuchstaben
Klasse MyClass
//Variablen Kleinbuchstaben
Objekt starten anObject
Im Allgemeinen verwenden aussagekräftige Namen , zum Beispiel " Zähler " statt " c " so , dass die Menschen (einschließlich sich selbst) Lesen sie den Code kann es leichter zu verstehen.
Einrücken
Einzug ist eines der wichtigsten Elemente in der Programmierung , der Code leichter zu lesen macht . Einzug sollte in der Regel spiegeln die logischen Strukturen in einem Programm , und hilft bei der Identifizierung Informationen auf einen Blick , zum Beispiel den Umfang der Variablen . Java-Konventionen auch diktieren, wo Brüche innerhalb eingewickelt Codezeilen auftreten sollten , mit den bevorzugten Zeilenumbrüche , die nach Kommas und vor den Operatoren , wie folgt:
aMethod ( parameterOne , parameterTwo ,
parameterThree );
int answer = itemOne + itemTwo
+ itemThree ; .
Die zweite Linie in diesen Fällen idealerweise nach acht Bereiche kommen sollte
Kommentare
Die Verwendung von Kommentaren macht Code leichter zu arbeiten, vor allem wenn lange oder komplexe Algorithmen beteiligt sind. Codekommentare nach Java Konventionen sollten vor Erklärungen der wichtigsten Variablen, Methoden , Klassen und alle langen Strukturen , sowohl innerhalb als auch alle diese einbezogen werden. Benutzen Sie beide Single-und Multi -line Kommentare , auftretende auf ihre eigenen Leitungen oder am Ende der Code-Zeilen :
/*
* Dies ist ein Kommentar in einem Block
* /Tablet
//Dies ist ein einzeiliger Kommentar
int counter = 0; //Das ist zusätzliche Informationen über die Codezeile
Dokumentation
Sie erstellen Java-Dokumentation in erster Linie mit dem Javadoc -Anlage, die die HTML-Dokumente die meisten Standard- Java -Ressourcen und Anwendungen Verwendung, einschließlich der Sprache selbst erzeugt . Sie erstellen Javadoc Inhalte innerhalb Quellcode mit Javadoc Kommentare :
/**
* Dies ist ein Javadoc-Kommentar
* - beachte den doppelten Sternchen zu beginnen
< p> * /Tablet
Wenn Entwickler mit Code, der von jemand anderem entwickelt arbeitete, ist ihr erster Bezugspunkt oft die Javadoc , da es einen Überblick über die Ressource liefert , ohne tatsächlich den Code lesen sich.
Program Design
Es gibt viele Konventionen und Standards für die Durchführung Details innerhalb von Java-Programmen . Ein solches Beispiel ist der Ansatz zum Zugriff auf die Variablen in einer Klasse von externem Code . (Siehe Referenzen 4) Es wird allgemein empfohlen , um Klassen-Variablen private, und den Zugang zu ihnen mit den öffentlichen Methoden . Zum Beispiel, wenn eine Klasse einen Text String-Instanz -Variable namens " someData " könnte es eine Methode Zugriff auf sie von anderswo in der Anwendung :
public string getData () {return someData ;}