ÉViter les erreurs avec de bons commentaires - les mannequins

Beaucoup de gens rejettent les commentaires comme un exercice conçu pour perdre du temps. Mais les commentaires sont en fait inestimables pour vous aider à vous rappeler pourquoi vous avez fait quelque chose d'une certaine manière et pour éviter les techniques qui n'ont pas fonctionné dans le passé. Au-delà de la documentation générale, cependant, les commentaires peuvent vous aider à éviter les erreurs.

Voici quelques-uns des avantages que vous pouvez tirer de bons commentaires:

• Les commentaires peuvent documenter des techniques qui ont ou n'ont pas fonctionné dans le passé.

• Vous pouvez utiliser les commentaires pour indiquer à quelqu'un l'objectif d'un script, d'une fonction ou d'une méthode, ce qui réduit le risque d'utiliser le mauvais code pour un besoin particulier.

• Un bon commentaire indique pourquoi quelque chose est fait d'une certaine manière, ce qui permet de s'assurer que les changements de code n'introduisent pas d'erreurs.

• Un commentaire complet signifie documenter les entrées et les sorties afin que tout le monde sache interagir avec un script, une fonction ou une méthode.

• Savoir qui contacter au sujet d'un problème particulier est une première ligne de défense contre les erreurs car l'auteur peut généralement dire à quelqu'un comment éviter les problèmes.

• Documenter l'environnement dans lequel le code est conçu pour fonctionner vous aide à comprendre quand des erreurs sont causées par des mises à jour d'autres logiciels (et non le script, la fonction ou la méthode elle-même).

La meilleure politique est d'éviter les erreurs quand vous le pouvez. Éviter une erreur est toujours moins coûteux que de se remettre d'une erreur. Cependant, l'erreur la plus coûteuse est celle qui est fatale et provoque le crash de l'application. Lorsque les applications tombent en panne, les utilisateurs perdent des données et les organisations perdent des clients. Une documentation appropriée aide les gens à mieux comprendre votre code et à éviter les erreurs avant qu'elles ne surviennent (ou même avant que quelqu'un puisse penser à un moyen de commettre l'erreur en premier lieu).

Le meilleur commentaire au monde ne peut pas empêcher toutes les erreurs. Certaines erreurs se produisent simplement, et il n'y a rien que vous puissiez faire à leur sujet. Par exemple, vous ne pouvez pas éviter une erreur qui se produit à la suite d'un coup de foudre (erreurs de données introduites par le courant électrique induit dans une connexion réseau). Parfois, des problèmes matériels et des logiciels tiers utilisés par MATLAB pour effectuer des tâches peuvent également contenir des erreurs. De nombreuses sources d'erreurs échappent à votre contrôle, mais l'utilisation efficace des commentaires vous aide à réduire le nombre d'erreurs que vous pouvez contrôler.