Formation Clean Code pour Java - Fournir du code de qualité

Jour 1

Présentation du Clean Code

• Un code "spaghetti" et les conséquences pour la maintenance
• L'héritage de codes de mauvaise qualité, les coûts cachés, des choix techniques passés
• Définition du Clean Code
• Principes
• Pour du code qualité
• Pour un code compréhensible, intuitif et facilement modifiable
• Les principes en 3 acronymes
• KISS : Keep It Simple Stupid
• DRY : Don't Repeat Yourself
• YAGNI : You Aren't Gonna Need It

Exemples de travaux pratiques (à titre indicatif)

• Analyse de projets contenant des problèmes de qualité de code importants, échanges sur les améliorations pouvant être apportées

Les règles de nommage

• Utiliser des noms clairs
• Faire des distinctions significatives
• Utiliser des noms prononçables
• Noms de classes, méthodes et domaines
• Un nom par concept
• Les notations typographiques
• Camel
• Pascal
• Snake case
• Les notations informatiques
• La notation hongroise
• Les autres notations
• Les conventions de nommage pour les éléments informatiques (fichiers, répertoires, variables...)

Exemple de travaux pratiques (à titre indicatif)

• Atelier d'écriture d'un programme respectant les normes et notations

Ecriture des fonctions

• Indépendance d'une fonction en rapport à son contexte
• Noms de fonctions
• Arguments et paramètres
• Effets collatéraux et effets de bord
• Bien traiter les erreurs et les exceptions dans les fonctions
• Clarté du code dans le programme, de haut en bas
• L'ordre d'apparition des fonctions dans le programme (Stepdown Rule)
• Comment commenter le code, qualité des commentaires
• Avantages de la programmation fonctionnelle

Exemples de travaux pratiques (à titre indicatif)

• Application au programme en cours d'écriture
• Règles d'écriture des fonctions

Mise en forme du code

• Objectifs de la mise en forme

• Mise en forme horizontale et verticale

• L'aide des outils de développement

Exemple de travaux pratiques (à titre indicatif)

• Application des règles de mise en forme au travers des IDE comme Visual Studio Code et Eclipse

Jour 2

Avantages et inconvénients des types de programmation

• Programmation
• Orientée objets
• Fonctionnelle
• Procédurale
• Avantages et inconvénients de chaque type de programmation
• Appliquer les principes SOLID
• La programmation "loose coupling" et "tight coupling"
• L'injection de dépendance

Exemple de travaux pratiques (à titre indicatif)

• Programmation d'un même algorithme selon plusieurs types de programmation et comparaison

Gestion des erreurs et exceptions

• Réaliser du code solide
• Comment bien utiliser la gestion des exceptions
• Réaliser une gestion d'exception utile, remontée du contexte

Exemple de travaux pratiques (à titre indicatif)

• A partir d'un programme contenant des bugs dus au manque de gestion d'erreurs, ajout de traitements d'exceptions afin de la rendre plus solide