Índice:
Definição - O que significa Comentário?
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. O principal motivo para incluir comentários nas linguagens de programação é melhorar a portabilidade e a manutenção de um código.
Techopedia explica Comentário
Freqüentemente, as equipes de desenvolvimento de software trabalham juntas em diferentes módulos de software, que são inspecionados pelos engenheiros de teste durante o processo de teste. Durante o processo de teste, os engenheiros precisam estar cientes do funcionamento de um módulo. Portanto, os 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 geralmente fornecem 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 famosos por odiar comentários e os veem 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 tenha herdado o código de uma equipe de desenvolvimento anterior dirá mais vezes do que não que o código não possui os comentários que gostaria de ver.
