Ao programar em um computador, às vezes é necessário deixar notas ou comentários para que outros desenvolvedores possam navegar em seu código com facilidade. Quer se trate de um projeto de código aberto ou proprietário, os comentários são necessários para coordenar com os co-desenvolvedores e possíveis desenvolvedores futuros. Sem comentários, o código seria simplesmente insustentável.
Passos
Etapa 1. Compreenda o propósito de comentar um programa de computador
- A legibilidade é o ponto principal aqui. Quando você olha um comentário, deve saber que é um comentário e não uma linha de código.
- O comentário também deve ser útil não apenas para você, mas para qualquer outra pessoa que possa ler o código-fonte do seu programa de computador.
Etapa 2. Pense em uma maneira curta e simples de transmitir seu ponto de vista
Os comentários não precisam ser uma obra de arte. Eles devem ser concisos, organizados e diretos ao ponto.
Isso não deve, no entanto, desencorajar o uso de várias linhas para um comentário. A questão é que a informação precisa chegar ao leitor
Etapa 3. Escreva o comentário usando a sintaxe apropriada fornecida pela linguagem de programação
Etapa 4. Pergunte a si mesmo se o comentário que você escreveu é suficientemente detalhado
Um comentário deve ser capaz de dizer a alguém olhando para o código-fonte o que essa parte do programa realmente faz, sem ter que compilá-lo e executá-lo. Seu comentário cumpre isso? Transmite todos os detalhes?