3. Documentez le code

Documenter le code et le commenter sont deux choses différentes. Le documenter consiste à avoir un ou des document(s), comme son nom l'indique, qui expliquent le fonctionnement du programme. Le commenter revient juste à inclure des petites notes entre les instructions, à l'aide de la syntaxe du langage ( /* commentaire */ pour le langage C), dans le code lui-même. Il est largement préférable d'avoir un document expliquant le fonctionnement du programme en détail que de simples commentaires. Et quoi de mieux qu'un code compréhensible pour un tel document? Je vais donc vous donner des idées pour que votre code soit le plus compréhensible possible, en indiquant les contraintes que cela entraîne.

3.1. L'algorithme, la structure de données et le commentaire

Voici trois parties d'un code: l'algorithme qui fait tourner le programme, la structure de données sur laquelle s'appuie l'algorithme, et le commentaire qui rend plus explicite le code. Jeu: laquelle de ces trois parties est la plus importante? Réponse: la structure de données. Pourquoi? Ecrivez un code avec la structure de données, l'algorithme et les commentaires. Supprimez les commentaires: cela compile toujours et cela marche toujours. Remettez les commentaires mais supprimez l'algorithme. Cela compile toujours et même si le programme ne fait rien, il s'exécute encore. Remettez l'algorithme, gardez les commentaires, mais supprimez la structure de données. Le programme ne compilera pas et s'exécutera encore moins! On pourrait aller plus loin en changeant un de ces trois éléments. Le changement de commentaires n'affecte pas l'exécution du programme. Un changement d'algorithme permet au programme d'aller plus vite ou moins vite suivant le nouvel algorithme choisi. Un changement de structure de données ne se fait pas sans une relecture de l'algorithme et éventuelle adaptation des commentaires!

Commentez votre code, monsieur, commentez votre code. Cette remarque vient souvent de gens qui sont incapable de lire votre code, sous-entendu la partie algorithmique du code. En effet, ces gens n'ont pas lu la structure de données ou ne l'ont pas comprise, et votre code n'est pas forcément clair. Commenter son code est cependant rarement nécessaire. En effet, si votre code est clair, basé sur votre structure de données elle-même d'une logique qui n'a d'égale que sa simplicité, et que vous avez suivi certaines règles de base, alors les commentaires qui pourraient encore être nécessaires seraient des références à des ouvrages qui expliquent la théorie et les algorithmes que vous avez utilisés, ou alors des commentaires indiquant des cas particulier et pourquoi ils sont particuliers. Le reste n'est qu'une affaire de bien programmer en suivant certaines règles.

création est mise à disposition sous un contrat Creative Commons