Appuyez sur Entrée pour voir vos résultats ou Echap pour annuler.

3 secrets derrière un code propre

Je réitère, encore et toujours… Coder est un art. Imaginez-vous à peindre une toile. Vous commencez alors par une esquisse au crayon, puis vous utilisez une technique précise dans chaque coup de pinceau. Tout comme le code, la beauté est dans les détails. Mais il faut faire attention de ne pas tout gâcher 😉

Aujourd’hui, je vous présente 3 secrets derrière un code propre. Je vous invite à ajouter les vôtres dans les commentaires!

1. Ne commentez pas votre code

Ceci ne s’applique pas si vous développez une API qui sera utilisée par d’autres développeurs. Par exemple : un framework, une facade, un module, etc..

Pourquoi?

Une application peut vite devenir volumineuse. Chaque commentaire doit être entretenu au même titre que le code pour éviter d’en avoir un qui induit en erreur. Le code ne ment jamais, mais les commentaires parfois.

Comment?

Lorsque vous écrivez un commentaire, vous être en train de dire : « Ce bout de code-là n’est pas clair. ».  Ceci arrive régulièrement devant une intruction conditionnelle. Sortez les conditions d’un if ou d’un while dès qu’elles sont complexes ( && , || , etc.) dans une méthode privée ou une classe utilitaire.

Retenez-vous un peu aussi…

Et surtout, avant de mettre un commentaire, posez-vous la question : Qu’est-ce que je peux changer à mon code qui remplacerait ce commentaire?

2. Limitez vos fonctions à 5 instructions

Pourquoi?

Si une fonction fait plus de 5 instructions, il y a de fortes chance qu’elle ne respecte pas le principe de reponsabilité unique (voir SOLID).

Comment?

Tous les environnements de développement modernes ont un outil de refactorisation (extract to method, Martin Fowler) qui vous permettra de créer des fonctions rapidement avec un raccourci clavier. Apprenez-le! Dès que vous sentez le besoin d’isoler une section de code avec des retours de chariot (ou un commentaire ;)), vous devriez trouver une façon de sortir ce code dans une fonction.

 

3. Définissez vos standards de programmation

Pourquoi?

Mis à part le fait que de voir du code formatté différemment dans un même projet peut faire saigner des yeux, les standards de programmation sont au développeurs ce que les lois sont à la société. Lorsqu’on travaille sur un projet, on y travaille en équipe. Alors autant visuellement grâce au formatage qu’architecturalement parlant grâce à la conception, le code doit sembler venir d’une seule personne (morale) : votre équipe.

Comment?

En équipe, rencontrez-vous et discutez-en. Le résultat doit être documenté à un endroit facile d’accès rapidement pour tous les membres de l’équipe. Puisque j’ai déjà écrit à ce sujet, je vous invite à lire mon article pour vous donner des pistes.

Conclusion

Si j’avais à résumer ces 4 points en une seule expression : Entendez-vous en équipe et rammassez-vous au fur et à mesure. Ne laissez-pas trainer de commentaires, des fonctions trop longues ou de définissez vos standards en équipe.

Avez-vous un secret =^-^= ?

Suivez-nous par courriel!

Saisissez votre adresse courriel pour vous abonner au blog d'Ezo et recevoir une notification de chaque nouvel article par email.

Rejoignez 9 autres abonnés