Règles, Normes, bonnes pratiques
Bonnes pratiques KObject : voir http://tutorial.kobject.net/java/bonnespratiques
Structure de l'application : dossiers, fichiers
- Pas de Majuscule au début d'un nom de fichier ou de dossier, camelCase pour la suite
- les vues (templates, jsp ) sont à placer dans des dossiers enfants de WEB-INF, respectant le code user story
Classes
| Package | Type de classe | Exemple de nommage |
|---|---|---|
| net.bo | Classes métier | KUtilisateur |
| net.display | Displays, classes héritant de KObjectDisplay | UtilisateurDisplay |
| net.controller | Contrôleurs, classes implémentant IMappingControl | LoginControl |
| net.action | Actions, Servlets ou actions | SModDev |
| net.technics | Classes techniques/utilitaires | - |
Mappings
- camelCase pour les requestURL en .do
- nom évocateur du rôle
- Notation hongroise (préfixe frm pour formulaires, lst pour listes, verbe pour actions)
- exemples :
- lstPlansActifs.do → liste des plans actifs
- frmCreerUtilisateur.do → formulaire de Création d'un utilisateur
- addUtilisateur.do → action de créer un utilisateur (utiliser un verbe en préfixe)
- homeDev.do → page d'accueil développeur
Eléments DOM
- notation camelCase + hongroise pour les ids des éléments DOM
| Type d'élément ou fonction | Préfixe | Exemple |
|---|---|---|
| bouton ou élément faisant office de bouton | bt | btEnter |
| checkbox | ck | ckDeleteUser |
| form | frm | frmKUtilisateur |
| fieldset | fs | fsKUtilisateur |
| radio | r | rVilles |
| div, span et autres | pas de préfixe |
Eléments communs
Variables de session
| Variable | Description |
|---|---|
| activeUser | Utilisateur actif connecté |
Eléments DOM
| id | Description |
|---|---|
| divMain | div principale de l'application, conteneur central |
| divLogin | div info activeUser ou form de login |
127.0.0.1