Le but des normes d’écriture de code est de parvenir à la standardisation du processus de codage et de développer de bonnes habitudes comportementales pour le développement futur de programmes.
Périmètre d'utilisation des spécifications d'écriture de code : Développement de projets J2EE.
Convention de dénomination des packages :
Objectif : La convention de dénomination des packages doit refléter une bonne répartition des ressources du projet.
Convention de dénomination du package où se trouve la classe de servlet : nom de la société.nom du groupe de développement.nom du projet.web.servlet
Par exemple : net.linkcn.web.servlet
Convention de dénomination du package dans lequel se trouve la classe de balises personnalisées : nom de l'entreprise.nom du groupe de développement.nom du projet.web.tags
Par exemple : net.linkcn.web.tags
Convention de dénomination du package où se trouve la classe de filtre : nom de la société.nom du groupe de développement.nom du projet.web.filter
Par exemple : net.linkcn.web.filter
Convention de dénomination du package où se trouve la classe Action : nom de la société.nom du groupe de développement.nom du projet.web.struts.action
Par exemple : net.linkcn.web.struts.action
Convention de dénomination du package où se trouve la classe ActionForm : nom de l'entreprise.nom du groupe de développement.nom du projet.web.struts.form
Par exemple : net.linkcn.web.struts.form
Convention de dénomination du package Javabean : nom de la société. nom du projet web.struts.service.impl.
Par exemple : net.linkcn.web.service.impl
Convention de dénomination de l'interface d'implémentation Javabean : nom de l'entreprise. Nom du groupe de développement. Nom du projet.web.service
Par exemple : net.linkcn.web.service
Convention de dénomination du package où se trouve la classe DAO : nom de l'entreprise.nom du groupe de développement.nom du projet.dao.impl
Par exemple : net.linkcn.dao.impl
L'interface implémentée par la classe DAO a une convention de dénomination dans le package : nom de l'entreprise.nom du groupe de développement.nom du projet.dao
Par exemple : net.linkcn.dao
Convention de dénomination du package où se trouvent la classe POJO et les fichiers hbm : nom de la société, nom du projet.dao.hbm.
Par exemple : net.linkcn.dao.hbm
Convention de dénomination du package où se trouvent les classes publiques globales et les classes d'interface : nom de la société. Nom du groupe de développement. Nom du projet.global
Par exemple : net.linkcn.global
Convention de dénomination du package où se trouve la classe d'outils globale : nom de l'entreprise.nom du groupe de développement.nom du projet.util
Par exemple : net.linkcn.util
Convention de dénomination des classes Convention de dénomination de base :
Convention de dénomination des classes et des interfaces : commencez par une lettre majuscule. S'il y a plusieurs mots, mettez en majuscule la première lettre de chaque mot. Par exemple : StudentInfo.
Convention de dénomination de l'interface : commencez par une lettre majuscule "I", s'il y a plusieurs mots, mettez en majuscule la première lettre de chaque mot. Par exemple : IStudentInfo.
Nom de la classe d’implémentation de l’interface :
Convention de dénomination : supprimez la première lettre "I" du nom de l'interface implémentée et terminez par "Impl". S'il y a plusieurs mots, mettez en majuscule la première lettre de chaque mot.
Par exemple : StudentInfoImpl
Convention de dénomination du framework J2EE+SSH
dénomination des classes de servlets :
Convention de dénomination : se termine par le mot Servlet. Par exemple : LoginServlet.
Dénomination POJO :
Utilisez simplement les classes générées automatiquement par hibernate
Nom de la classe DAO :
Utilisez simplement les classes générées automatiquement par hibernate
Dénomination de la classe d'action :
Convention de dénomination : la dénomination des actions est basée sur le nom du POJO, le nom du POJO Action
Par exemple:
Un nom POJO est Diary et son action correspondante est DiaryAction.
Dénomination de la classe ActionForm :
Convention de dénomination : la dénomination d'ActionForm est déterminée par le nom du POJO et le nom du POJO Form.
Par exemple:
Un nom POJO est Diary et son actioForm correspondant est DiaryForm
Dénomination de l’interface de logique métier :
Convention de dénomination : le nom de l'interface de logique métier est déterminé par le nom POJO et le nom IPOJO est Service.
Par exemple:
Un nom POJO est Diary et son interface de logique métier correspondante est IDiaryService.
Dénomination des classes d'implémentation de la logique métier :
Convention de dénomination : le nom de la classe d'implémentation de l'interface de logique métier est basé sur le nom POJO. Par exemple :
Un POJO est nommé Diary et la classe d'implémentation d'interface de logique métier correspondante est nommée DiaryServiceImpl.
Nom des variables de classe :
Convention de dénomination : La première lettre du nom de la variable doit être en minuscule. Si le nom de la variable est composé de plusieurs mots, la première lettre des mots suivants doit être en majuscule. N'utilisez pas "_" pour relier les mots. Le nom de la variable doit être privé. Vous pouvez ajouter des méthodes setter et getter.
Par exemple : private int studentAge ;
public int getStudentAge()
{
retourner studentAge ;
}
public void setStudentAge (int studentAge)
{
this.studentAge=studentAge;
}
Dénomination constante :
Convention de dénomination : toutes les lettres sont en majuscules. S'il y a plusieurs mots, les mots doivent être séparés par "_". Et la variable doit être de type public, static, final Par exemple : public static final String USER_NAME=”userName”;
Convention de dénomination de la méthode : la première lettre doit être en minuscule. Si le nom de la variable est composé de plusieurs mots, la première lettre des mots suivants doit être en majuscule. N'utilisez pas "_" pour relier les mots. N'utilisez pas de noms pour les mots.
Par exemple : public int checkLogin(String name,String pwd){}
Spécifications d'annotation : les spécifications d'annotation sont l'élément le plus important de l'ensemble des spécifications de développement et doivent être strictement mises en œuvre.
Notes de cours :
Fonction : annotez l’ensemble de la classe et décrivez brièvement la fonction de la classe.
Convention d'écriture : Les annotations de classe doivent être écrites avant la syntaxe de déclaration de la classe. Dans les commentaires, décrivez la fonction de base de la classe, l'auteur, la date, la version, le nom de l'entreprise et la déclaration de droit d'auteur.
Format:
/* *
* Description de la fonction de la classe : (décrire grossièrement la fonction de la classe)
* @author : nom de l'auteur
*
* @version : le numéro de version du fichier de classe commence à partir de 1.0 (déterminez vous-même l'ajout et la modification du numéro de version
* Situation), statut de modification (heure de modification, auteur, statut de modification)
*
* @see nom du package. Nom de la classe de référence (liste des classes parentes, introduction des classes, chaque classe occupe une ligne), le cas échéant.
*peut être omis
* Données pertinentes telles que : (pour faciliter la compréhension de certaines données constantes de cette classe et le format de certaines données
* Ou des données considérées comme importantes, si elles ne sont pas disponibles, elles peuvent être omises)
*/
La syntaxe de déclaration de classe est la suivante :
/**
*
Titre : Cours de traitement des données du module Administrateur
*
Description : Ajouter deux nombres
*
Droits d'auteur : Droits d'auteur (c) 2007
*
Entreprise : Société de logiciels Huateng
*
* @auteur Tong Jinhu
*
* @version $Révision : 1,7 $ $Date : 2007/07/08$
*/
classe publique AdminDAO
Commentaires variables et constants :
Fonction : Décrivez brièvement la signification de cette variable.
Normes de rédaction : les commentaires sur les variables doivent être écrits avant la définition de la variable, décrivant brièvement sa signification.
Format:
/**
* Description de la fonction de la variable : (décrire grossièrement la fonction de la variable)
*/
Par exemple:
/**
*Définir la variable d'âge
*/
âge public int ;
Commentaires sur la méthode :
Fonction : une brève description de la fonction de la méthode, des annotations sur la signification de ses paramètres et des valeurs de retour.
Convention d'écriture : Les commentaires de méthode doivent être rédigés avant la définition de la méthode. L'annotation comprend : une brève description de la fonction de la méthode, une brève description des paramètres de la méthode, le type de valeur de retour et la signification de la valeur de retour.
Format:
/**
*Description de la fonction de la méthode
* @param args (le type du paramètre peut être écrit après le paramètre, ou il peut être omis
* Omis. Chaque paramètre occupe une ligne)
* Paramètres de sortie @return (plusieurs situations écrites sur la même ligne)
* @see class #reference method (les méthodes liées à l'appel de cette méthode sont pour référence
* Pour les examens, il n'est pas nécessaire de lister toutes les méthodes dans leur intégralité. Vous devez en choisir celles qui ont du sens.
*Les méthodes occupent une ligne)
* Classe de gestion des exceptions @exception (exceptions pouvant être levées dans la méthode, chacune
*Les exceptions occupent une ligne)
*/
Par exemple:
/**
* Changer le mot de passe administrateur
* @param adminId numéro d'administrateur
* @param oldPassword ancien mot de passe
* @param password nouveau mot de passe
* @return boolean si l'édition a réussi
* @throws UserException
* @throws ServiceException
*/
public booleaneditAdminPassword(int adminId,String oldPassword,
Mot de passe de chaîne) lève UserException, ServiceException ;
Nom des pages Jsp :
Convention de dénomination : le nom de la page jsp doit commencer par une lettre minuscule. S'il se compose de plusieurs mots, les mots suivants doivent commencer par une lettre majuscule. Le nom doit refléter la signification de la page et doit de préférence être lié au nom du module.
Par exemple:
login.jsp --Page de connexion
register.jsp --Page d'inscription
message.jsp --Page de message client
Spécifications d'organisation du dossier de projet du projet J2EE :
Objectif : Standardiser la forme d'organisation des ressources des applications Web des étudiants et prendre de bonnes habitudes d'organisation des fichiers. L'organisation du document doit refléter la division en modules.
Selon les caractéristiques de l'outil Eclipse, la structure des répertoires du projet est :
src
----Stockage des fichiers Java
Racine Web
|--images --stocke les images publiques requises par les programmes Web
|--css -- stocke les feuilles de style publiques requises par les programmes Web
|--js --Store les fichiers js publics requis par les programmes Web
|--commons --stocke les fichiers publics requis par les programmes Web
|--Dossier du module de fonction (pour stocker les ressources liées à un certain module de fonction)
|--images --stocke les images liées à ce module fonction
|--css --Stocke les fichiers de feuille de style liés à ce module
|--js --Store les fichiers js liés à ce module
|--jsp, page HTML
|--WEB-INF
|--cours
|--lib
|--fichier tld
Spécifications de soumission de projet J2EE Une fois le projet terminé, le projet doit être livré à l'utilisateur sous forme de produit. Un bon cahier des charges d'organisation du projet permet aux utilisateurs de trouver facilement les ressources nécessaires au projet et reflète également le professionnalisme de l'entreprise. Lors de la soumission d'un projet, celui-ci doit être soumis dans le format de fichier suivant.
Dossier principal du projet :
Fonction : Stocker d'autres fichiers de ressources du projet.
Convention de dénomination : time_class number_group X.
Par exemple : 070706_GS2T18_Groupe 4.
Le dossier principal du projet comprend les dossiers et fichiers suivants :
|--src : enregistrez le fichier .java.
|--database : enregistrez le fichier de script ou le fichier de sauvegarde de la base de données.
|--source : enregistrez tous les fichiers dans le répertoire WebRoot du projet Eclipse.
|--depend : enregistrez les autres fichiers jar sur lesquels vous devez compter pour compiler le programme.
|--javadoc : enregistrez la documentation de l'API javadoc générée par toutes les classes.
|--war : fichier d'archive pour sauvegarder le programme
|--xx.war : Le fichier de projet a été empaqueté et peut être exécuté directement.
|--project : enregistrez le code d'ingénierie et les fichiers d'origine du projet de développement.
|--Manuel du produit.doc : montre comment utiliser le produit en images et en texte.
|--build.xml : script fourmi, utilisé pour générer des fichiers war en cours d'exécution.
|--Explication du projet.ppt : ppt pour l'explication du projet (ppt est uniquement destiné à être utilisé dans les projets de simulation scolaire et non à d'autres fins commerciales)
Remarque : Dans un projet complet, la base de données doit disposer d'une certaine quantité de données de test valides pour prendre en charge le fonctionnement du programme.