3 Conseils pour coder proprement

Nettoyez votre code et devenez plus performant !

Chaque année, du temps et des ressources sont gaspillés à cause d’un code mal écrit. Toutefois, ce n’est pas une fatalité.

Cet Article est en fait une suite de petits conseils apparemment importants, sur lesquels vous apprendrez à rédiger du bon code, ainsi qu’à le nettoyer « à la volée », et vous obtiendrez des applications plus robustes, plus évolutives et donc plus durables.

C’est peu de choses, et c’est pourtant ces petits conseils valent de l’or. 

• Un code bien commenté

Le premier point, peut-être le plus délicat pour des raisons de dosage, concerne les commentaires dans le code.

En effet, les commentaires sont pour vous, et éventuellement pour la personne qui lira votre code. Il faut commenter votre code, mais il ne faut surtout pas tomber dans l’excès !

C’est le sens général de votre code que vous devez expliquer dans les commentaires, et non pas le rôle de chaque ligne !

• Des noms significatifs

Quand vous créez un script ou une application, vous devez inventer des noms. Vous allez devoir donner des noms à différents types d’éléments :

• Les variables
• Les fonctions
• Les classes

L’idée est simple : il faut que vous fassiez l’effort de choisir des noms de variables et de fonctions clairs et compréhensibles.

Par exemple, voici des mauvais noms de variables :

• $i
• $ma_variable
• $x
• $donne
• $info
• $valeur
• $val2

Je n’ai pas inventé ces noms de variables, en fait  ce sont des noms que j’ai vraiment vus dans de nombreux codes source.

Voici quelques exemples de noms de variables clairs :

• $ip_visiteur
• $login_membre
• $date_inscription
• $mot_de_passe

• Mettre un texte en retrait pour en faciliter la lisibilité

Une des premières choses qui saute aux yeux quand on regarde un code source, c’est sa mise en forme. Le principe de la mise en forme, c’est d’utiliser intelligemment les tabulations pour « décaler » certaines parties de votre code, afin de montrer plus clairement la structure.

Il y a plusieurs « styles » d’indentation de code, cela varie un peu selon les goûts des développeurs. Celui que je vous propose est simple à retenir :

A chaque fois que vous ouvrez des accolades {, par exemple pour if, un while ou un for, vous décalez tout le code qui suit d’une tabulation vers la droite.
A chaque fois que vous fermez une accolade }, vous décalez tout le code qui suit d’une tabulation vers la gauche.
J’espère que ces conseils vous aideront pour vos prochaines applications et si vous avez d’aures conseils n’hésiter pas de les partager avec nous dans un commentaire.