Namenskonvention für die Java-Projektentwicklung (Anordnung der Energieknoten)

Der Zweck der Definition dieser Spezifikation besteht darin, alle Dokumente im Projekt so aussehen zu lassen, als wären sie von einer Person geschrieben worden, die Lesbarkeit zu erhöhen und Verluste durch Vertretungen im Projektteam zu reduzieren. Lassen Sie mich die Namenskonvention für die Java-Entwicklung mit Ihnen teilen. Schauen wir uns das gemeinsam an

Am besten verwenden Sie Englisch anstelle von Chinesisch Pinyin

1: Paket (Paket): Wird verwendet, um Klassen zu klassifizieren, die verschiedene Funktionen ausführen, und sie in verschiedenen Verzeichnissen (Paketen) zu platzieren. Die Namensregeln des Pakets: Umkehren des Firmendomänennamens als Paketnamen. Beispiel: www.bjpowernode.com Für Paketnamen: Jeder Buchstabe muss kleingeschrieben sein. Zum Beispiel: com.bjpowernode.test; der vollständige Name der Testklasse unter diesem Paket ist: com. Wenn beim Definieren einer Klasse kein Paket verwendet wird, geht Java davon aus, dass die von uns definierte Klasse im Standardpaket enthalten ist.

2: Klasse: Der erste Buchstabe wird großgeschrieben. Wenn eine Klasse aus mehreren Wörtern besteht, wird der erste Buchstabe jedes Wortes großgeschrieben und in der Mitte werden keine Konnektoren verwendet. Benutzen Sie möglichst viel Englisch. Beispiel: ConnectionFactory

3: Methode: Das erste Wort besteht ausschließlich aus Kleinbuchstaben. Wenn eine Methode aus mehreren Wörtern besteht, wird der erste Buchstabe ab dem zweiten Wort großgeschrieben und es werden keine Konnektoren verwendet. addPerson

4: Attribute: Gleich wie Methode. Beispiel: ageOfPerson

5: Konstante: Die Buchstaben aller Wörter sind Großbuchstaben. Wenn es mehrere Wörter gibt, verwenden Sie einfach Unterstreichungslinks.

Zum Beispiel:

public static final int AGE_OF_PERSON = 20; //通常加上static

Zusätzlich: Achten Sie bei der Benennung von Variablen auf folgende Punkte:

· Wählen Sie einen aussagekräftigen Namen und achten Sie darauf, den ersten Buchstaben jedes Wortes groß zu schreiben.

· Verwenden Sie nicht dieselbe Variable, um zwei Werte mit unterschiedlichen Bedeutungen in einer -Funktion darzustellen.

· i, j, k usw. werden nur als Schleifenindexvariablen für kleine Schleifen verwendet.

· Vermeiden Sie die Verwendung von Flag zur Benennung von Zustandsvariablen.

· Verwenden Sie Is, um logische Variablen zu benennen, wie zum Beispiel: blnFileIsFound. Durch die positive Benennung boolescher Variablen können andere Entwickler die Bedeutung boolescher Variablen besser verstehen.

· Hängen Sie bei Bedarf einen Berechnungsqualifizierer an das Ende der Variablen an, z. B.: curSalesSum.

· Die Namen curSales und curSalesSum sind nicht inklusive.

· Die Namen statischer Endvariablen (Konstanten) sollten großgeschrieben werden und die vollständige Bedeutung sollte angegeben werden.

· Wenn Sie den Variablennamen abkürzen müssen, müssen Sie auf die Konsistenz der Abkürzungsregeln im gesamten Code achten. Wenn Sie beispielsweise in einigen Bereichen Ihres Codes intCnt und in anderen intCount verwenden, erhöhen Sie die Komplexität Ihres Codes unnötig. Es wird empfohlen, Abkürzungen in Variablennamen zu vermeiden.

· Indem Sie am Ende einen Quantifikator platzieren, erstellen Sie einheitlichere Variablen, die leichter zu verstehen und zu durchsuchbar sind. Verwenden Sie beispielsweise strCustomerFirst und strCustomerLast anstelle von strFirstCustomer und strLastCustomer. Häufig verwendete Quantifizierer-Suffixe sind: First (die erste in einer Gruppe von Variablen), Last (die letzte in einer Gruppe von Variablen), Next (die nächste Variable in einer Gruppe von Variablen), Prev (vorherige Variable in einem Satz von Variablen), Cur (aktuelle Variable in einem Satz von Variablen).

· Wählen Sie den besten Datentyp für jede Variable, was den Speicherbedarf reduzieren, die Codeausführung beschleunigen und die Möglichkeit von Fehlern verringern kann. Der für eine Variable verwendete Datentyp kann sich auf die Ergebnisse von Berechnungen auswirken, die für diese Variable durchgeführt werden. In diesem Fall generiert der Compiler keinen Laufzeitfehler, sondern erzwingt lediglich, dass der Wert den Datentypanforderungen entspricht. Solche Probleme sind äußerst schwer zu finden.

· Versuchen Sie, den Umfang der Variablen so weit wie möglich zu reduzieren. Wenn der Gültigkeitsbereich einer Variablen größer ist, als er sein sollte, kann die Variable weiterhin existieren und Ressourcen belegen, lange nachdem die Variable nicht mehr benötigt wird. Das Hauptproblem bei ihnen besteht darin, dass sie mit jeder Methode in jeder Klasse geändert werden können und es schwierig ist, genau zu verfolgen, wo die Änderung vorgenommen wurde. Die Belegung von Ressourcen ist ein wichtiger Aspekt im Zusammenhang mit dem Umfang. Bei Variablen hat es große Auswirkungen auf die Zuverlässigkeit der Anwendung, den Umfang so klein wie möglich zu halten.

In Bezug auf die Benennungsmethode von Konstanten wird im JAVA-Code empfohlen, jederzeit Konstanten zu verwenden, um Zahlen und feste Zeichenfolgen zu ersetzen. Mit anderen Worten: Außer 0 und 1 sollten möglichst keine anderen Zahlen im Programm vorkommen. Konstanten können am Anfang des Programms oder in einem größeren Umfang definiert werden. Die Namen sollten in Großbuchstaben angegeben werden und die vollständige Bedeutung der Konstante angeben. Wenn ein Konstantenname aus mehreren Wörtern besteht, sollten die Wörter durch einen Unterstrich „_“ getrennt werden, z. B.: NUM_DAYS_IN_WEEK, MAX_VALUE.

Das obige ist der detaillierte Inhalt vonNamenskonvention für die Java-Projektentwicklung (Anordnung der Energieknoten). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!