Comentário

Muitas vezes citado como uma das convenções de programação mais úteis e menos usadas, um comentário é uma nota de texto adicionada ao código fonte para fornecer informações explicativas, geralmente sobre a função do código. Comentários são normalmente úteis para alguém que mantém ou melhora seu código quando você não está mais por perto para responder perguntas sobre ele. Desenvolvedores pares às vezes avaliam o código para a integridade e legibilidade de seus comentários.

Para habilitar o compilador da linguagem de programação a reconhecer comentários e não confundi-los com instruções s, um caractere especial é usado (como "#," " /* ," " ' " e " // ") para sinalizar o início ou o fim de um comentário. Os caracteres iniciais dos comentários HTML ( <!-- ") dizem ao navegador para não mostrar o texto entre eles e os caracteres finais (" --> "); o texto dentro destes caracteres de enquadramento dos comentários é visível, no entanto, para qualquer pessoa que leia o código. Lendo esta página em um navegador Web, por exemplo, você pode selecionar "View" e depois "Source" para ver o código HTML da página, incluindo os comentários.

Um programa deve incluir pelo menos: um bloco file comment block que descreve o conteúdo do arquivo, para que alguém lendo o arquivo possa entendê-lo sem ter que ler o código em si, e um bloco function comment block que descreve cada unidade funcional de código. Além disso, alguns codificadores fornecem um comentário para cada instrução de linguagem.