Général
Nommage des variables et méthodes
Mettre des noms explicites qui permettent, à la lecture d’une ligne, de comprendre immédiatement ce que contient une variable ou ce que fait une fonction (sans avoir lu le code avant ou après cette ligne).
Pas de franglish, tout mettre en anglais correctement traduit.
Rester constant
Rester constant dans les manières de faire, l’architecture, le nommage, etc… Se baser sur ce qui existe déjà dans le projet en tant qu’exemple.
Prioriser les couches basses de l’architecture
Se poser la question de savoir si tout ou partie d’un algorithme ne pourrait pas être déplacé plus bas dans l’architecture. Plus c’est bas dans l’architecture, plus l’application est stable et facile à maintenir.
Ionic/Angular (frontend)
Séparation composant/service
Essayer de bien séparer les responsabilités en poussant le maximum de logique et de traitements dans le service. Le composant doit uniquement servir pour la logique d’affichage.
Exemple de mise en oeuvre
Ces extraits de code font la même chose, le second est clairement plus facile à lire (et donc à maintenir).
| Avant | Après |
|---|---|
|
|
Template HTML
Utiliser au maximum les composants Ionic.
Eviter les balises HTML “classiques” (ex: div, ul, li, etc…).
Eviter autant que possible d’utiliser du CSS personnalisé (plutôt favoriser les classes prédéfinies d’Ionic).
Essayer de garder le DOM aussi léger en minimisant autant que possible le nombre de balises.
Si la logique dans le template devient trop complexe, faire les traitements dans le composant afin de simplifier au maximum le template.
Exemple de mise en oeuvre (logique trop complexe dans le template)
On déplace ici une partie de la logique dans le composant afin de simplifier et rendre plus lisible le template.
| Avant | Après |
|---|---|
|
|
Rxjs
Privilégier l’utilisation du pipe async avec un Observable & pipe , plutôt que de faire un
subscribequi met à jour une variable "synchrone".
Elf
Distinction Props/Entities
Dans les stores Elf, privilégier les entities plutôt que les props quand il s'agit de collection d'objet qui disposent d'un identifiant (ID numérique, code unique, etc...) car les entities disposent de méthodes de manipulation de la collection (suppression par l’ID, etc…).