Detaillierte Erläuterung der Codespezifikationen für die Java-Entwicklung

Die bei der Java-Entwicklung zu befolgenden Codierungsstandards umfassen im Allgemeinen die folgenden 7 Punkte. Namensspezifikationen, Kommentarspezifikationen, Einrückungsformatierungsspezifikationen, Dateinamenspezifikationen, Deklarationsspezifikationen, Anweisungsspezifikationen und Programmierspezifikationen. [Empfohlenes Lernen: Java-Video-Tutorial]

1. Namenskonvention

(1) Alle Bezeichner können nur ASCⅡ-Buchstaben (A-Z oder a-z), Zahlen (0-9) und den Unterstrich „_“ verwenden.

(2) Das Präfix eines eindeutigen Paketnamens besteht immer aus Kleinbuchstaben. Zum Beispiel: www.tonysun.cc

(3) Der Klassenname ist ein Substantiv in gemischter Groß- und Kleinschreibung, wobei der erste Buchstabe jedes Wortes groß geschrieben wird. Zum Beispiel: Tony.

(4) Die Groß-/Kleinschreibungsregeln für Schnittstellen ähneln denen von Klassennamen: zum Beispiel: Tony.

(5) Der Methodenname ist ein Verb oder eine Verbphrase, in gemischter Schreibweise. Der erste Buchstabe des ersten Wortes wird klein geschrieben und der erste Buchstabe der nachfolgenden Wörter wird großgeschrieben. Zum Beispiel: setNeekeName(StringneekeName).

(6) Der erste Buchstabe des Variablennamens ist kleingeschrieben und der erste Buchstabe aller dazwischen liegenden Wörter wird groß geschrieben. Variablennamen sollten kurz und leicht zu merken sein. Zum Beispiel: neekeName, neekeAddress. Vermeiden Sie Variablennamen mit nur einem Zeichen, außer bei einmaligen temporären Variablen.

(7) Die Konstantendeklaration sollte ausschließlich in Großbuchstaben erfolgen, wobei jedes Wort durch „_“ verbunden wird. Zum Beispiel: finalStringWWW_TONY_CN="www.tonysun.cc";

2. Kommentarspezifikationen

( 1) Kommentare sollten so oft wie möglich „//“ verwenden; für alle Javadoc-Kommentare verwenden Sie „/***/“ und für temporäre Kommentare zu Codeblöcken versuchen Sie, „/**/“ zu verwenden; ".

(2) Alle Quelldateien sollten am Anfang einen Kommentar enthalten, der den Dateinamen, das Datum und einen funktionalen Überblick über die Klasse enthält.

(3) Dokumentationskommentare müssen zu jeder Methode hinzugefügt werden (mit Ausnahme der main()-Methode der Klasse).

(4) Jedes Attribut muss kommentiert werden.

(5) Der Code enthält mindestens 15 % Kommentare.

(6) Kommentare sind auf Chinesisch.

3. Spezifikationen für die Einrückungsformatierung

(1) Vermeiden Sie eine Zeile mit mehr als 60 Zeichen.

(2) Verwenden Sie die Quellcode-Formatierungsfunktion von Eclipse, um die Einrückung des Codes abzuschließen (Strg+Umschalt+F).

4. Dateinamenspezifikationen

(1) Eine Java-Quelldatei kann nur eine Java-Klasse speichern.

(2) Der Dateiname ist derselbe wie der Java-Klassenname.

(3) Die Codezeilen einer Klassendatei dürfen 200 Zeilen nicht überschreiten.

5. Deklarationsspezifikationen

(1) Deklarieren Sie eine Variable in einer Zeile.

(2) Platzieren Sie Deklarationen von Variablen unterschiedlichen Typs nicht in derselben Zeile.

(3) Deklarieren Sie Variablen nur am Anfang des Codeblocks.

(4) Alle Variablen müssen bei der Deklaration initialisiert werden.

(5) Vermeiden Sie, dass deklarierte lokale Variablen Variablen überschreiben, die auf der vorherigen Ebene deklariert wurden.

(6) Methoden werden durch Leerzeilen getrennt.

6. Anweisungsspezifikationen

(1) Jede Zeile enthält mindestens eine einfache Anweisung.

(2) In der Return-Anweisung ist der Rückgabewert nicht in Klammern „()“ eingeschlossen.

(3) If-Anweisungen werden immer in „{“ und „}“ eingeschlossen.

(4) Vermeiden Sie in der Initialisierungs- oder Aktualisierungsklausel der for-Anweisung eine Erhöhung der Komplexität, die durch die Verwendung von mehr als drei Variablen verursacht wird.

(5) Wenn ein Switch nach unten ausgeführt wird (da es keine break-Anweisung gibt), sollten Kommentare normalerweise an der Stelle der break-Anweisung hinzugefügt werden.

7. Programmierspezifikationen

(1) Stellen Sie eine öffentliche oder private Zugriffskontrolle für Instanzen und Klassenvariablen bereit und wenden Sie keine Standardwerte oder geschützte Zugriffskontrolle an so viel wie möglich.

(2) Vermeiden Sie die Verwendung eines Objekts, um auf statische Variablen oder Methoden einer Klasse zuzugreifen. Stattdessen sollten Klassennamen verwendet werden.

(3) Vermeiden Sie es, mehreren Variablen in einer Anweisung denselben Wert zuzuweisen.

(4) Verwenden Sie die Anweisung switch(), um mehrere Zweige zu implementieren.

(5) Wenn Sie JDBC verwenden, sollten Sie die Verwendung von java.sql.PreparedStatement anstelle von java.sql.Statement in Betracht ziehen.

(6) Das Präfix der Methode, die zum Festlegen des Status des Objekts verwendet wird, muss festgelegt werden Die zum Abrufen anderer Methoden verwendete Methode muss get sein.

(7) Zahlen (oder Zeichen) sollten im Programm so wenig wie möglich verwendet werden und statische Variablen sollten so weit wie möglich definiert werden, um die Bedeutung der Zahl (oder des Zeichens) zu veranschaulichen. Wenn im Programm eine Zuweisung oder ein Vergleich erforderlich ist, verwenden Sie die zuvor definierten statischen Variablen. Ausnahme in der Schleifensteuerung.

Dieser Artikel stammt aus der Rubrik Java-Einführung, willkommen zum Lernen!

Das obige ist der detaillierte Inhalt vonDetaillierte Erläuterung der Codespezifikationen für die Java-Entwicklung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!