Evitando erros com bons comentários - dummies

Muitas pessoas descartam comentários como um exercício destinado a perder tempo. Mas os comentários são realmente inestimáveis, ajudando você a lembrar por que você fez algo de uma certa maneira e a evitar técnicas que não funcionaram no passado. Além da documentação geral, no entanto, os comentários podem ajudá-lo a evitar erros.

Os seguintes são alguns dos benefícios que você obtém de bons comentários:

• Os comentários podem documentar técnicas que têm ou não funcionaram no passado.

• Você pode usar os comentários como um meio para dizer a alguém o propósito de um script, função ou método - reduzindo o potencial para usar o código errado para uma necessidade particular.

• Um bom comentário diz por que algo é feito de uma certa maneira, o que ajuda a garantir que as alterações de código não introduzam erros.

• Comentário completo significa documentar entradas e saídas para que todos saibam interagir com um script, função ou método.

• Saber quem contactar sobre uma questão específica é uma primeira linha de defesa contra erros porque o criador geralmente pode dizer a alguém como evitar problemas.

• Documentar o ambiente em que o código é projetado para operar ajuda você a entender quando os erros são causados ​​por atualizações de outro software (e não o script, a função ou o próprio método).

A melhor política é evitar erros sempre que possível. Evitar um erro é sempre menos dispendioso do que recuperar de um erro. No entanto, o erro mais caro de todos é um que é fatal e faz com que o aplicativo falhe. Quando as aplicações falham, as pessoas perdem dados e as organizações perdem clientes. A documentação adequada ajuda as pessoas a entender melhor o seu código e evitar erros antes de acontecerem (ou mesmo antes de alguém pensar na forma de fazer o erro no primeiro lugar).

O melhor comentário no mundo não pode impedir todos os erros. Alguns erros simplesmente acontecem, e não há nada que você possa 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 o MATLAB usa para executar tarefas também podem conter erros. Muitas fontes de erros estão fora do seu controle, mas usar os comentários efetivamente ajuda você a reduzir o número de erros que você pode controlar.