Java-Namenskonvention

Bei der objektorientierten Programmierung ist die Benennung von Klassen, Objekten, Methoden, Variablen usw. sehr geschickt. Unterscheiden Sie beispielsweise zwischen Groß- und Kleinschreibung, verwenden Sie unterschiedliche Anfangsbuchstaben usw. Aber zurück zu den Wurzeln: Bei der Benennung einer Ressource sollte diese auf der Grundlage der beiden Merkmale Beschreibendheit und Einzigartigkeit benannt werden, um sicherzustellen, dass es keinen Konflikt zwischen Ressourcen gibt und dass jede einzelne leicht zu merken ist.

Paketbenennung

Die Namen von Java-Paketen bestehen aus kleingeschriebenen Wörtern. Aufgrund der Merkmale der objektorientierten Java-Programmierung kann jedoch jeder Java-Programmierer sein eigenes Java-Paket schreiben. Um die Einzigartigkeit jedes Java-Paketnamens sicherzustellen, müssen Programmierer in den neuesten Java-Programmierspezifikationen ihr eigenes Java definieren Dem Paketnamen ist ein eindeutiges Präfix vorangestellt. Da Domänennamen im Internet nicht wiederholt werden, verwenden Programmierer im Allgemeinen ihren eigenen Domänennamen im Internet als eindeutiges Präfix für ihre eigenen Programmpakete.
Zum Beispiel: net.frontfree.javagroup

Klassenbenennung

Der Klassenname muss mit einem Großbuchstaben beginnen und die anderen Buchstaben im Wort sind Kleinbuchstaben; wenn der Klassenname aus besteht Wenn mehrere Wörter zusammengesetzt sind, sollte der erste Buchstabe jedes Wortes groß geschrieben werden, z. B. TestPage. Wenn der Klassenname eine Abkürzung enthält, sollte jeder Buchstabe des geschriebenen Wortes groß geschrieben werden, z. B. XMLExample Entwickelt, um Objekte darzustellen. Versuchen Sie daher, bei der Benennung von Klassen Substantive zu wählen.
Zum Beispiel: Kreis

Name der Methode

Das erste Wort des Methodennamens sollte mit einem Kleinbuchstaben beginnen, und nachfolgende Wörter sollten mit einem Großbuchstaben beginnen.
Zum Beispiel: sendMessge

Benennung von Konstanten

Die Namen von Konstanten sollten alle Großbuchstaben verwenden und die vollständige Bedeutung der Konstante angeben. Wenn ein Konstantenname aus mehreren Wörtern besteht, sollten die Wörter durch Unterstriche getrennt werden.
Zum Beispiel: MAX_VALUE

Parameterbenennung

Die Parameterbenennungskonvention ist dieselbe wie die Methodenbenennungskonvention. Um Verwirrung beim Lesen des Programms zu vermeiden, stellen Sie bitte sicher, dass die Der Parametername besteht aus einem Wort. Machen Sie die Parameterbenennung so klar wie möglich.

Javadoc-Kommentare

Zusätzlich zu unseren allgemeinen Kommentarmethoden definiert die Java-Sprachspezifikation auch einen speziellen Kommentar, den wir Javadoc-Kommentar nennen und der verwendet wird, um die API in unserem Code aufzuzeichnen. Javadoc-Kommentare sind mehrzeilige Kommentare, die mit /**beginnend mit*/ enden. Die Kommentare können einige HTML-Tags und spezielle Schlüsselwörter enthalten. Der Vorteil der Verwendung von Javadoc-Kommentaren besteht darin, dass die geschriebenen Kommentare automatisch in Online-Dokumente umgewandelt werden können, wodurch die Mühe entfällt, separate Programmdokumentationen zu schreiben.
Zum Beispiel:

/**
* This is an example of
* Javadoc
*
* @author darchon
* @version 0.1, 10/11/2002
*/

Am Anfang jedes Programms wird im Allgemeinen Javadoc verwendet, um die Gesamtbeschreibung des Programms und die Copyright-Informationen zu kommentieren. Später werden im Hauptprogramm jede Klasse, jede Schnittstelle usw. mit Anmerkungen versehen. Fügen Sie zu Beginn jedes Kommentars einen Satz hinzu, um die von der Klasse, der Schnittstelle, der Methode und dem Feld ausgeführten Funktionen zusammenzufassen , Sie können detailliertere Beschreibungsabsätze folgen. Auf die beschreibenden Absätze können auch einige spezielle Absätze folgen, die mit Javadoc-Kommentar-Tags beginnen, wie z. B. @auther und @version im obigen Beispiel. Diese Absätze werden im generierten Dokument auf eine bestimmte Weise angezeigt.
Obwohl das Hinzufügen von Kommentaren zu einem schlecht gestalteten Programm es nicht zu einem guten Programm macht, kann Ihnen das Schreiben des Programms gemäß Programmierstandards und das Hinzufügen guter Kommentare zum Programm dabei helfen, ein Programm zu schreiben, das perfekt gestaltet, effizient und einfach auszuführen ist. Das Verständnis von Abläufen und Programmierkonventionen wird noch wichtiger, insbesondere wenn mehrere Personen gemeinsam an demselben Projekt arbeiten. Wie das Sprichwort sagt: „Ob Sie Ihr Schwert schärfen oder Holz hacken“, lohnt es sich, etwas Zeit in die Anpassung an die Java-Programmierstandards zu investieren.