Il y a deux principales stratégies programmeurs peuvent utiliser pour
améliorer la compréhension de programmes, et chacun a ses propres
avantages et inconvénients.
La première méthode consiste à ajouter de la documentation de code
pendant ou après la création de code, et la deuxième est d'écrire du
code en mettant l'accent sur sa structure.
Une combinaison des deux approches est utile pour la plupart des
programmeurs, mais il y a certains constructeurs de code qui préfèrent
une stratégie plutôt qu'une autre.
Quelle est la méthode à utiliser est une question de préférence
personnelle par le programmeur, et toute tentative de clarifier le code
est beaucoup mieux que rien du tout.
Ajout
de la documentation de code est le plus simple des deux méthodes, et
quand bien fait, il peut être une béquille très utile à un programmeur
familier avec la langue le code est écrit en jeu. La plupart des
langages informatiques ont un style spécifique de la documentation pour
aider à la compréhension de programmes.
Si la documentation du code est écrit bien, première étape d'un nouveau
programmeur peut être de lire toute la documentation et les
commentaires d'acquérir une compréhension de la façon dont le programme
fonctionne, sans avoir lu le code du tout.
Au lieu d'être dépendante de la syntaxe du code et de la mécanique, le
programmeur peut voir ce qui se passe en texte brut, puis le texte se
rapportent précisément à ce qui se passe à un endroit donné.
Lors de l'ajout de documentation pour code, cependant, les programmeurs
doivent être prudents, parce que trop de documentation peut être
déroutant et intrusive, plutôt que utile.
Lors de l'écriture du code en mettant l'accent sur la structure, un
programmeur suppose que tous les autres responsables qui cherchent à son
code auront une connaissance équivalente de la syntaxe et de la
mécanique de la langue. Parfois, cette hypothèse est valable, mais il ne peut pas toujours être invoquée.
compréhension du programme repose en grande partie sur la structure est
possible, mais il faut beaucoup plus de travail de la part du
programmeur d'origine pour le faciliter.
La mécanique et la syntaxe de la langue doivent être suivies à la
lettre, ainsi que toutes les conventions stylistiques, et tout doit être
cohérent.
Lors de l'écriture de code de cette façon, un programmeur doit toujours
être conscient que ce qui est évident pour lui peut-être pas clair pour
une autre personne.
Même lors de l'écriture de code avec un oeil pour la compréhension du
programme plus tard, des documents supplémentaires ou des modifications
de structure peut être nécessaire plus tard. Ceci est une partie naturelle de la maintenance du code, et pas un échec de la part du programmateur.
Le travail d'un programmeur est à prévoir autant de problèmes de
compréhension que possible, mais tous ne sont pas toujours pris.
