Evitar erros com bons comentários
Um monte de pessoas descartar comentários como um exercício projetado para perder tempo. Mas os comentários são realmente inestimável para ajudar você a se lembrar por que você fez algo de uma certa maneira e evitar técnicas que não funcionaram no passado. Além documentação geral, no entanto, os comentários podem ajudar a evitar erros.
A seguir estão alguns dos benefícios que você derivar de bons comentários:
Os comentários podem documentar técnicas que tenham ou não tenham trabalhado no passado.
Você pode usar os comentários como um meio de dizer a alguém o propósito de um script, função ou método - reduzindo o potencial de utilizar o código errado para uma necessidade particular.
Um bom comentário diz por que algo seja feito de uma certa maneira, o que ajuda a garantir que as mudanças de código não introduzir erros.
meios comentando completos documentar entradas e saídas para que todos saibam como interagir com um script, função ou método.
Saber quem contactar sobre um assunto em particular é uma primeira linha de defesa contra erros porque o originador geralmente pode dizer a alguém como evitar problemas.
Documentando o ambiente no qual o código é projetado para operar ajuda a entender quando os erros são causados por alterações de outro software (e não o script, função ou método em si).
A melhor política é para evitar erros sempre que puder. Evitar um erro é sempre menos dispendioso do que se recuperar de um erro. No entanto, o erro mais caro de todos é aquele que é fatal e faz com que o aplicativo falhar. Quando os aplicativos de acidente, as pessoas perdem os dados e as empresas perdem clientes. documentação adequada ajuda as pessoas a entender o seu código melhor e evitar erros antes que eles aconteçam (ou mesmo antes que alguém pode pensar em uma maneira de fazer o erro em primeiro lugar).
O melhor comentário no mundo não pode evitar todos os erros. Alguns erros simplesmente acontecer, e não há nada que você pode fazer sobre eles. Por exemplo, você não pode evitar um erro que ocorre como resultado de um raio (erros de dados introduzidos pela corrente elétrica induzida em uma conexão de rede). Às vezes, falhas de hardware e software de terceiros que MATLAB usa para executar tarefas podem conter erros, também. Muitas fontes de erros estão fora de seu controle, mas usando comentários efetivamente ajuda a reduzir o número de erros que você pode controlar.