L'utilisation propice de fonctions, méthodes et classes permet de distinguer les programmeurs expérimentés. Vous trouverez dans cette dernière section quelques conseils qui vous aideront par la suite.
Les fonctions et les méthodes doivent toujours se charger d'une seule chose:
Si vous ne pouvez pas résumer en une ligne ce que fait votre fonction, elle est probablement trop compliquée;
Si le code de votre fonction ne tient pas sur un seul écran, elle est probablement trop longue.
Des études ont démontré qu'un être humain se souvient au maximum de 7 choses à la fois. Si votre fonction comporte plus de 6 variables, elle est probablement trop compliquée, et trop longue.
Plus vous écrirez de programmes complexes, plus l'usage de commentaires se révélera important:
Les commentaires ne doivent pas nécessairement être longs. Ils doivent juste expliquer clairement l'objectif du code.
Chaque fonction devrait avoir un commentaire qui stipule ce que fait la fonction. Exceptionnellement, vous pouvez omettre le commentaire si la fonction est si simple que son usage est évident.
Dans le cas du carnet d'adresses:
Les méthodes initialize, ajoute et retire n'ont pas besoin d'être commentées.
Dans le code de la classe, les méthodes chaque_personne et chaque_adresse ont un seul commentaire, qui stipule que ce sont des itérateurs. Une fois que le programmeur sait que ces méthodes sont des itérateurs, il devine plus facilement l'usage de ces méthodes.
Même chose pour la méthode par_nom, dont le commentaire explique au lecteur qu'il s'agit d'une fonction de tri.
Les commentaires peuvent également être utilisés pour grouper ensemble une série de fonctions communes. Par exemple, dans le carnet d'adresses, nous avons utilisé des commentaires pour rassembler les «méthodes fondamentales», «itérateurs» et «fonctions de tri».
Astuce | |
---|---|
Essayez toujours de diviser le code en petites parties, plus facilement maintenables. |