Top 5 des meilleures façons d'améliorer votre code

TOP 5 DES MEILLEURES
FAÇON D'AMÉLIORER
VOTRE CODE .NET

Write once
read many.

INTRODUCTION
 Legacy code is code
without tests
 Michael Feather dans
Working effectively with
legacy code

 Sans une
maintenance
constante, le code se
dégrade rapidement
 Nous devons
détecter et éliminer
les "code smell"
© Pyxis Technologies inc.

Top 5 des meilleures façon d'améliorer votre code

2

MES 5 AMÉLIORATIONS
1. Simplifier les conditionnels
2. Supprimer la documentation
3. Clarifier les contrats
4. Réduire le scope
5. Éliminer le code mort


3

SIMPLIFIER LES CONDITIONNELS –
POURQUOI?

1
2
3
4
5






Réduit la
Améliore
Améliore
Améliore

complexité
la lisibilité
la maintenabilité
la réutilisabilité



4

SIMPLIFIER LES CONDITIONNELS–
QUAND?

1
2
3
4
5







il y a plus d'une condition (and / or);
il y a trop de code dans le body;
la condition est basée sur un type;
il y a des if imbriqués
il y a plusieurs décisions basées sur la même information (if
/ else if / switch case)



5

SIMPLIFIER LES CONDITIONNELS –
COMMENT?

1
2
3
4
5

 Refactor conditional statement








Decompose conditional
Consolidate conditional expression
Consolidate duplicate conditional fragments
Introduce null object
Flatten nested if
Don't use negative
Keep conditional statement lean

 Avoid conditional statement
 Replace conditional with polymorphism
 Replace conditional logic with strategy
 Replace conditional dispatcher with command



6

DECOMPOSE CONDITIONAL
1
2

4
5

SIMPLIFIER LES
CONDITIONNELS

3



7

CONSOLIDATE CONDITIONAL EXPRESSION
1
2

4
5

SIMPLIFIER LES
CONDITIONNELS

3



8

CONSOLIDATE DUPLICATE CONDITIONAL
FRAGMENTS

1
2

4
5

SIMPLIFIER LES
CONDITIONNELS

3



9

INTRODUCE NULL OBJECT
1
2

4
5

SIMPLIFIER LES
CONDITIONNELS

3



10

FLATTEN NESTED IF
1
2

4
5

SIMPLIFIER LES
CONDITIONNELS

3



11

DON'T USE NEGATIVE
1
2

4
5

SIMPLIFIER LES
CONDITIONNELS

3



12

KEEP CONDITIONAL STATEMENT LEAN
1

 Autant que possible, avoir une seule condition

2

 Utilisez une méthode pour combiner plusieurs
condition

4
5

 SIMPLIFIER LES
CONDITIONNELS

3

 Inverser le if si la plupart (ou tout) le code se
trouve dans la branche true
 Attention à la double négation



13

REPLACE CONDITIONAL WITH
POLYMORPHISM

1
2

4
5

SIMPLIFIER LES
CONDITIONNELS

3



14

REPLACE CONDITIONAL LOGIC WITH
STRATEGY

1
2

4
5

SIMPLIFIER LES
CONDITIONNELS

3



15

REPLACE CONDITIONAL DISPATCHER WITH
COMMAND

1
2

4
5

SIMPLIFIER LES
CONDITIONNELS

3



16

1

SUPPRIMER LA DOCUMENTATION –
POURQUOI?

2
3
4

 Améliore la lisibilité
 Améliore la maintenabilité
 Évite les commentaires désuet

5



17

1

QUAND?

2
3
4
5

 Chaque fois qu'un commentaire est autre chose que de
l'information (utile), une intention, une clarification, un
avertissement, un TODO ou une amplification.
 Le commentaire est le seul contenu d'un bloc de code
 Catch vide

 Le commentaire décrit, ligne par ligne, le code
 Exemple:





//
//
//
//

Getting connection string from configuration
Opening connection
Retrieving data
Closing connection



18

COMMENT?

1
2
3
4
5

 Remplacez les commentaires par une bonne nomenclature
 Extract method
 Utilisez des noms significatifs

 Écrivez des commentaires utiles
 Respectez la nomenclature (MSDN: Guidelines for names)





Properties
Enums
Events
Methods



19

EXTRACT METHOD
1
2

4
5

SUPPRIMER LA
DOCUMENTATION

3



20

UTILISEZ DES NOMS SIGNIFICATIFS
1

 Nommez selon l'intention / évitez le mapping

2

4
5

 Évitez la désinformation

 SUPPRIMER LA
DOCUMENTATION

3

 d  elapsedDays

 AccountList  Accounts

 Assurez-vous d’avoir une distinction significative
 amount  invoiceTotal, invoiceSubTotal

 Utilisez des noms prononçables
 genymdhms  generationTimestamp

 Utilisez un nom pour nommer une classe
 Utilisez un verbe pour nommer une méthode
 Ne soyez pas créatif, utilisez les nom standards
 Destroy, Kill, Obliterate  Delete

 Domaine de solution ↔ domaine du problème



21

PROPERTIES
1

3
4
5

 SUPPRIMER LA
DOCUMENTATION

2

 Utilisez le PascalCase naming
 Nommez les propriété avec un nom ou un adjectif
 N'utilisez pas de noms qui pourraient être
confondu avec une méthode Get
 Préfixez les booléen avec Can, Is ou Has



22

ENUMS
1

3
4
5

 SUPPRIMER LA
DOCUMENTATION

2

 Considérez le premier
élément comme valeur par
défaut
 Utilisez le PascalCasing
naming
 Les Enum simples doivent
utiliser le singulier
 Les Enum de type Bit fields
devraient utiliser le pluriel
er avoir l'attribut Flags
 Les valeurs des Enum de
type bit fields doivent être
coherentes (Read & Write
== ReadWrite)



23

EVENTS
1

3
4
5

 SUPPRIMER LA
DOCUMENTATION

2

 Utilisez le PascalCase naming
 Nommez les événement avec un verbe au
present progressive pour les pré-événements et
au passé pour les post-événements
 Fournissez une version virtual de l'événement
 Fournissez une façon d'annuler un pré événement



24

EVENTS
1

3
4
5

 SUPPRIMER LA
DOCUMENTATION

2



25

METHODS
1

 Utilisez des verbes pour nommer les méthodes

2

4
5

 SUPPRIMER LA
DOCUMENTATION

3

 ProcessPayment

 Exprimez clairement le retour attendu lors de
l'appel de la méthode
 CreateCustomer
 GetInvoice

 Utilisez une nomenclatue uniforme (Get, Fetch ou
Retrieve mais pas tous dans le même contexte)



26

1

CLARIFIER LES CONTRATS –
POURQUOI?

2
3
4

 Améliore la performance
 Améliore la lisibilité
 Améliore la reutilisabilité

5



27

CLARIFIER LES CONTRATS– QUAND?

1
2
3
4
5






Il y a trop de paramètres (combien est -ce?)
Un méthode fait plus d'une chose
Une méthode utilise des paramètre out
Vous avez besoin de valeur par défaut



28

1

CLARIFIER LES CONTRATS–
COMMENT?

2
3
4
5

 Réduisez le nombre de paramètres
 Introduce parameter object
 Create overload with less parameters
 Use default value

 Les ouputs
 La valeur de retour
 Les paramètres out

 Overload dans le bon ordre



29

2
3
4
5

CLARIFIER LES CONTRATS

1

INTRODUCE PARAMETER OBJECT



30

2
3
4
5


1

CREATE OVERLOAD WITH FEWER
PARAMETERS



31

2
3
4
5


1

USE DEFAULT VALUE



32

1

RÉDUIRE LE SCOPE – POURQUOI?

2
3
4

 Évite les effets de bords
 Améliore la réutilisabilité
 Améliore la maintenabilité

5



33

1

RÉDUIRE LE SCOPE – QUAND?

2
3

 Un field est utilisé par trop peu de méthodes
 Les membres publiques expose le comportement interne

4
5



34

1

RÉDUIRE LE SCOPE – COMMENT?

2
3
4
5

 Visibilité
 protected
 private
 internal

 Responsabilité
 Déplacer un field vers une méthode
 Scinder un classe
 Déplacer un variable près de son utilisation

 Durée de vie
 Créer les instances au besoin
 Éviter de garder des références inutiles



35

ÉLIMINER LE CODE MORT –
POURQUOI?

1
2
3
4
5







Parcequ'il le faut
Améliore la maintenabilité
Améliore la performance
Améliore la lisibilité
100% de couverture de test



36

1

ÉLIMINER LE CODE MORT – QUAND?

2
3
4

 Vous savez que le code est mort
 Vous pensez que le code est mort
 Vous voulez que le code soit mort

5



37

1

ÉLIMINER LE CODE MORT – COMMENT?

2
3
4
5

 Identifiez et retirez le code mort
 Effacez le code
 Compilez
 Roulez les tests

 Qu'est-ce que du code mort?
 Du code en commentaire
 Toutes lignes de code non couverte par un test unitaire

 Outils
 Il existe des outils qui supprime automatiquement le code non
couvert par au moins un test



38

REFERENCES
 Refactoring – Improving the design of existing code
 Auteur: Martin Fowler
 Edition: Addison Wesley
 ISBN: 978-0-201-48567-7

 Refactoring to patterns (Martin Fowler signature)
 Auteur: Joshua Kerievsky
 Edition: Adison Wesley
 ISBN: 978-0-321-21335-1

 Clean code – a handbook of agile software craftsmanship
 Auteur: Robert C. Martin
 Edition: Prentice Hall
 ISBN: 978-0-132-35088-4

 Working effectively with legacy code
 Auteur: Michael C. Feather
 Edition: Prentice Hall
 ISBN: 978-0-13-117705-5



39

LA FIN
 Questions?
 Rappelez-vous

Simplifier les
conditionnels

Supprimer la
documentation

Clarifier les
contrats

Réduire le
scope

Éliminer le
code mort

 Eric De Carufel
 eric@decarufel.net
 http://blog.decarufel.net


40

Top 5 des meilleures façons d'améliorer votre code

Contenu connexe

Similaire à Top 5 des meilleures façons d'améliorer votre code

Plus de Eric De Carufel

Top 5 des meilleures façons d'améliorer votre code

Notes de l'éditeur