Quem já não fez um código ou página, e depois de 1 ano (ou até mais), teve que alterar o código, e ficou horas procurando a linha certa que você queria alterar? Quanto tempo você já não gastou tentando relembrar a lógica da aplicação, até conseguir encontrar o que procurava?
Não passe mais por isso: COMENTE SEU CÓDIGO
Parece um trabalho "bobo", quase "sem sentido", mas é o único jeito de você fazer um "trabalho profissional" em desenvolvimento de sites e parar de perder tempo ("time is money!!!").
Cada linguagem tem o seu coméntario próprio:
No Asp e no DotNet, é o apóstrofe.
No PHP, é o BARRA-BARRA (//), ...
O mais utilizado, é o do HTML, usando:
Citação:
<!-- COMENTARIOS AQUI -->
... mas o comentário HTML é visível no código do cliente, o que, muitas vezes, não é conveniente, pois pode passar algumas informações importantes sem necessidade.
No CFML, o comentário é invisível no código-fonte do cliente, e por isso é mais recomendado, usando:
Citação:
<!--- COMENTARIOS AQUI --->
Veja como é parecido com o comentário HTML, mas tem 3 sinais de "menos" ao invés de 2 sinais. Por isso, preste bem atenção nisso!! Vai que você esquece e coloca uma senha como comentário HTML?!
