Der Zweck von Code-Schreibstandards besteht darin, eine Standardisierung im Codierungsprozess zu erreichen und gute Verhaltensgewohnheiten für die zukünftige Programmentwicklung zu entwickeln.
Anwendungsbereich der Code-Schreibspezifikationen: J2EE-Projektentwicklung.
Namenskonvention für Pakete:
Zweck: Die Namenskonvention von Paketen sollte eine gute Aufteilung der Projektressourcen widerspiegeln
Namenskonvention für das Paket, in dem sich die Servlet-Klasse befindet: Firmenname.Name der Entwicklungsgruppe.Name des Projekts.web.servlet
Beispiel: net.linkcn.web.servlet
Namenskonvention für das Paket, in dem sich die benutzerdefinierte Tag-Klasse befindet: Firmenname.Name der Entwicklungsgruppe.Name des Projekts.web.tags
Beispiel: net.linkcn.web.tags
Namenskonvention für das Paket, in dem sich die Filterklasse befindet: Firmenname.Name der Entwicklungsgruppe.Name des Projekts.web.filter
Zum Beispiel: net.linkcn.web.filter
Namenskonvention für das Paket, in dem sich die Action-Klasse befindet: Firmenname.Name der Entwicklungsgruppe.Name des Projekts.web.struts.action
Zum Beispiel: net.linkcn.web.struts.action
Namenskonvention für das Paket, in dem sich die ActionForm-Klasse befindet: Firmenname.Name der Entwicklungsgruppe.Name des Projekts.web.struts.form
Zum Beispiel: net.linkcn.web.struts.form
Benennungskonvention für Javabean-Pakete: Name des Firmenentwicklungsgruppenprojekts
Beispiel: net.linkcn.web.service.impl
Namenskonvention für die Javabean-Implementierungsschnittstelle: Firmenname.Name der Entwicklungsgruppe.Name des Projekts.web.service
Beispiel: net.linkcn.web.service
Namenskonvention für das Paket, in dem sich die DAO-Klasse befindet: Firmenname.Name der Entwicklungsgruppe.Name des Projekts.dao.impl
Zum Beispiel: net.linkcn.dao.impl
Die von der DAO-Klasse implementierte Schnittstelle verfügt über eine Namenskonvention im Paket: Firmenname.Name der Entwicklungsgruppe.Name des Projekts.dao
Zum Beispiel: net.linkcn.dao
Namenskonvention für das Paket, in dem sich die POJO-Klasse und die hbm-Dateien befinden: Name des Firmenprojekts.dao.hbm
Zum Beispiel: net.linkcn.dao.hbm
Namenskonvention für das Paket, in dem sich globale öffentliche Klassen und Schnittstellenklassen befinden: Firmenname.Name der Entwicklungsgruppe.Name des Projekts.global
Beispiel: net.linkcn.global
Namenskonvention für das Paket, in dem sich die globale Toolklasse befindet: Firmenname.Name der Entwicklungsgruppe.Name des Projekts.util
Beispiel: net.linkcn.util
Klassenbenennungskonvention Grundlegende Namenskonvention:
Namenskonvention für Klassen und Schnittstellen: Beginnen Sie mit einem Großbuchstaben. Wenn es mehrere Wörter gibt, schreiben Sie den ersten Buchstaben jedes Wortes groß
Namenskonvention für die Benutzeroberfläche: Beginnen Sie mit einem Großbuchstaben „I“. Wenn mehrere Wörter vorhanden sind, schreiben Sie den ersten Buchstaben jedes Wortes groß. Beispiel: IStudentInfo
Benennung der Schnittstellenimplementierungsklasse:
Namenskonvention: Entfernen Sie den ersten Buchstaben „I“ aus dem implementierten Schnittstellennamen und enden Sie mit „Impl“. Wenn es mehrere Wörter gibt, schreiben Sie den ersten Buchstaben jedes Wortes groß.
Zum Beispiel: StudentInfoImpl
Namenskonvention für das J2EE+SSH-Framework
Benennung der Servlet-Klasse:
Namenskonvention: endet mit dem Wort Servlet. Beispiel: LoginServlet
POJO-Benennung:
Verwenden Sie einfach die vom Ruhezustand automatisch generierten Klassen
Benennung der DAO-Klasse:
Verwenden Sie einfach die vom Ruhezustand automatisch generierten Klassen
Benennung der Aktionsklasse:
Benennungskonvention: Die Aktionsbenennung basiert auf dem POJO-Namen und dem POJO-Namen „Aktion“.
Zum Beispiel:
Ein POJO-Name ist Diary und die entsprechende Aktion ist DiaryAction.
Benennung der ActionForm-Klasse:
Namenskonvention: Die Benennung von ActionForm wird durch den POJO-Namen und den POJO-Namen Form bestimmt
Zum Beispiel:
Ein POJO-Name ist Diary und die entsprechende actioForm ist DiaryForm
Benennung der Geschäftslogikschnittstelle:
Namenskonvention: Die Benennung der Geschäftslogikschnittstelle wird durch den POJO-Namen bestimmt, und der IPOJO-Name lautet Service
Zum Beispiel:
Ein POJO-Name ist Diary und die entsprechende Geschäftslogikschnittstelle ist IDiaryService.
Benennung der Geschäftslogik-Implementierungsklasse:
Namenskonvention: Die Benennung der Implementierungsklasse der Geschäftslogikschnittstelle basiert auf dem POJO-Namen. Beispiel:
Ein POJO heißt Diary und die entsprechende Implementierungsklasse der Geschäftslogikschnittstelle heißt DiaryServiceImpl.
Benennung von Klassenvariablen:
Namenskonvention: Der erste Buchstabe des Variablennamens muss kleingeschrieben sein. Wenn der Variablenname aus mehreren Wörtern besteht, muss der erste Buchstabe der folgenden Wörter nicht groß geschrieben werden Der Variablenname muss privat sein. Sie können Setter- und Getter-Methoden hinzufügen.
Zum Beispiel: private int studentAge;
public int getStudentAge()
{
return studentAge;
}
public void setStudentAge(int studentAge)
{
this.studentAge=studentAge;
}
Konstante Benennung:
Namenskonvention: Alle Buchstaben werden in Großbuchstaben geschrieben. Wenn mehrere Wörter vorhanden sind, sollten die Wörter durch „_“ getrennt werden. Und die Variable muss vom Typ public, static, final sein, zum Beispiel: public static final String USER_NAME=“userName“;
Namenskonvention für Methoden: Der erste Buchstabe muss aus Kleinbuchstaben bestehen. Wenn der Variablenname aus mehreren Wörtern besteht, sollte der erste Buchstabe der folgenden Wörter nicht in Großbuchstaben geschrieben werden. Verwenden Sie keine Substantive für Wörter.
Zum Beispiel: public int checkLogin(String name,String pwd){}
Annotationsspezifikationen: Annotationsspezifikationen sind der wichtigste Bestandteil der gesamten Entwicklungsspezifikation und müssen strikt umgesetzt werden.
Unterrichtsnotizen:
Funktion: Kommentieren Sie die gesamte Klasse und skizzieren Sie kurz die Funktion der Klasse.
Schreibkonvention: Klassenanmerkungen müssen vor der Deklarationssyntax der Klasse geschrieben werden. Beschreiben Sie in den Kommentaren die Grundfunktion der Klasse, Autor, Datum, Version, Firmennamen und Copyright-Erklärung.
Format:
/* *
* Beschreibung der Klassenfunktion: (Beschreiben Sie grob die Funktion der Klasse)
* @author: Name des Autors
*
* @version: Die Versionsnummer der Klassendatei beginnt bei 1.0 (bestimmen Sie das Hinzufügen und Ändern der Versionsnummer selbst).
* Situation), Änderungsstatus (Änderungszeitpunkt, Autor, Änderungsstatus)
*
* @see-Paketname. Referenzklassenname (übergeordnete Klassen auflisten, Klassen einführen, jede Klasse belegt eine Zeile), falls vorhanden
*kann weggelassen werden
* Relevante Daten wie: (um das Verständnis einiger konstanter Daten dieser Klasse und des Formats einiger Daten zu erleichtern
*Oder Daten, die als wichtig erachtet werden; wenn sie nicht verfügbar sind, können sie weggelassen werden)
*/
Die Syntax der Klassendeklaration lautet wie folgt:
/**
*
Titel:Administratormodul-Datenverarbeitungsklasse
*
Beschreibung: Addiere zwei Zahlen
*
Urheberrecht: Copyright (c) 2007
*
Unternehmen: Huateng Software Company
*
* @Autor Tong Jinhu
*
* @version $Revision: 1.7 $ $Datum: 08.07.2007$
*/
öffentliche Klasse AdminDAO
Variable und konstante Kommentare:
Funktion: Beschreiben Sie kurz die Bedeutung dieser Variablen.
Schreibstandards: Variablenkommentare müssen vor der Variablendefinition geschrieben werden und ihre Bedeutung kurz beschreiben.
Format:
/**
* Beschreibung der Variablenfunktion: (Beschreiben Sie grob die Funktion der Variablen)
*/
Zum Beispiel:
/**
*Altersvariable definieren
*/
öffentliches Int-Alter;
Kommentare zur Methode:
Funktion: Eine kurze Beschreibung der Funktion der Methode, Anmerkungen zur Bedeutung ihrer Parameter und Rückgabewerte.
Schreibkonvention: Methodenkommentare müssen vor der Methodendefinition geschrieben werden. Die Anmerkung umfasst: eine kurze Beschreibung der Funktion der Methode, eine kurze Beschreibung der Parameter der Methode, des Rückgabewerttyps und der Rückgabewertbedeutung.
Format:
/**
*Beschreibung der Methodenfunktion
* @param args (Der Parametertyp kann nach dem Parameter geschrieben oder weggelassen werden
* Weggelassen. Jeder Parameter belegt eine Zeile)
* @return-Ausgabeparameter (mehrere Situationen in derselben Zeile geschrieben)
* @see-Klasse #Referenzmethode (Methoden im Zusammenhang mit dem Aufruf dieser Methode dienen als Referenz
* Bei Prüfungen ist es nicht erforderlich, alle Methoden vollständig aufzulisten. Es müssen sinnvolle Methoden ausgewählt werden.
*Methoden belegen eine Zeile)
* @Exception-Ausnahmebehandlungsklasse (Ausnahmen, die jeweils in der Methode geworfen werden können
*Ausnahmen belegen eine Zeile)
*/
Zum Beispiel:
/**
* Administratorpasswort ändern
* @param adminId Administratornummer
* @param oldPassword altes Passwort
* @param Passwort neues Passwort
* @return boolean, ob die Bearbeitung erfolgreich war
* @throws UserException
* @throws ServiceException
*/
public booleaneditAdminPassword(int adminId,String oldPassword,
String-Passwort) löst UserException,ServiceException aus;
Benennung der JSP-Seite:
Namenskonvention: Der JSP-Seitenname sollte mit einem Kleinbuchstaben beginnen. Wenn er aus mehreren Wörtern besteht, sollten die nachfolgenden Wörter mit einem Großbuchstaben beginnen. Der Name sollte die Bedeutung der Seite widerspiegeln und vorzugsweise mit dem Modulnamen verknüpft sein.
Zum Beispiel:
login.jsp – Anmeldeseite
register.jsp – Registrierungsseite
message.jsp – Kundennachrichtenseite
Spezifikationen für die Organisation des J2EE-Projektprojektordners:
Zweck: Standardisierung der Ressourcenorganisationsform der Webanwendungen der Schüler und Entwicklung guter Gewohnheiten für die Dateiorganisation. Die Organisation des Dokuments sollte die Unterteilung in Module widerspiegeln.
Entsprechend den Merkmalen des Eclipse-Tools lautet die Verzeichnisstruktur des Projekts:
src
----Java-Dateien speichern
WebRoot
|--images --store öffentliche Bilder, die von Webprogrammen benötigt werden
|--css – speichert die von Webprogrammen benötigten öffentlichen Stylesheets
|--js – Speichern Sie öffentliche JS-Dateien, die von Webprogrammen benötigt werden
|--commons --store öffentliche Dateien, die von Webprogrammen benötigt werden
|--Funktionsmodulordner (zum Speichern von Ressourcen, die sich auf ein bestimmtes Funktionsmodul beziehen)
|--images --store Bilder, die sich auf dieses Funktionsmodul beziehen
|--css – Speichern Sie die Stylesheet-Dateien, die sich auf dieses Modul beziehen
|--js – Speichern Sie JS-Dateien, die sich auf dieses Modul beziehen
|--jsp, HTML-Seite
|--WEB-INF
|--classes
|--lib
|--tld-Datei
J2EE-Projekteinreichungsspezifikationen Nach Abschluss des Projekts muss das Projekt dem Benutzer als Produkt geliefert werden. Gute Projektorganisationsspezifikationen ermöglichen Benutzern das einfache Auffinden der für das Projekt erforderlichen Ressourcen und spiegeln auch die Professionalität des Unternehmens wider. Bei der Einreichung eines Projekts muss dieses im folgenden Dateiformat eingereicht werden.
Hauptordner des Projekts:
Funktion: Speichern Sie andere Ressourcendateien des Projekts.
Namenskonvention: time_class number_group X.
Zum Beispiel: 070706_GS2T18_Gruppe 4.
Der Hauptordner des Projekts umfasst die folgenden Ordner und Dateien:
|--src: .java-Datei speichern.
|--database: Speichern Sie die Skriptdatei oder die Datenbanksicherungsdatei der Datenbank.
|--source: Speichern Sie alle Dateien im WebRoot-Verzeichnis im Eclipse-Projekt.
|--depend: Speichern Sie andere JAR-Dateien, auf die Sie sich beim Kompilieren des Programms verlassen müssen.
|--javadoc: Speichern Sie die von allen Klassen generierte Javadoc-API-Dokumentation.
|--war: Archivdatei zum Speichern des Programms
|--xx.war: Die Projektdatei wurde gepackt und kann direkt ausgeführt werden.
|--project: Speichern Sie den ursprünglichen technischen Code und die Dateien des Entwicklungsprojekts.
|--Produkthandbuch.doc: Zeigt in Bildern und Texten die Verwendung des Produkts.
|--build.xml: Ant-Skript, das zum Generieren laufender WAR-Dateien verwendet wird.
|--Projekterklärung.ppt: ppt für Projekterklärung (ppt ist nur für die Verwendung in Schulsimulationsprojekten und nicht für andere kommerzielle Zwecke vorgesehen)
Hinweis: In einem vollständigen Projekt muss die Datenbank über eine bestimmte Menge gültiger Testdaten verfügen, um den Betrieb des Programms zu unterstützen.