Definição – o que o comentário significa?
Um comentário é uma construção especial em uma linguagem de programação que permite ao desenvolvedor do programa mencionar informações adicionais associadas ao programa. A principal razão para incluir comentários em linguagens de programação é melhorar a portabilidade e manutenção de um código.
Definirtec explica o comentário
Freqüentemente, as equipes de desenvolvimento de software trabalham juntas em diferentes módulos de software, que são inspecionados por engenheiros de teste durante o processo de teste. Durante o processo de teste, os engenheiros devem estar cientes do funcionamento de um módulo. Portanto, comentários são incluídos pelo desenvolvedor para explicar o funcionamento de um módulo específico, declarando os tipos válidos de entradas, o número de entradas, o algoritmo usado para processamento no módulo interno, as saídas esperadas e as condições de erro que podem ser encontradas durante o processamento.
Os comentários também costumam fornecer informações sobre o autor do conteúdo, a data e hora em que foi desenvolvido e a data e hora em que foi modificado pela última vez. A quantidade de detalhes a incluir é uma questão de subjetividade. Alguns desenvolvedores são notórios por odiar comentários e vê-los como uma perda de tempo. Para outros, os comentários são uma necessidade absoluta. Em teoria, uma organização deve estabelecer todos os seus padrões de codificação. Ainda assim, por qualquer motivo, qualquer pessoa que herdou o código de uma equipe de desenvolvimento anterior dirá mais vezes do que não que o código não tem os comentários que eles gostariam de ver.