As notas de que as linhas de documentos ou seções de um programa são chamadas
Comentários .
Os comentários são notas explicativas dentro do código -fonte de um programa que é ignorado pelo compilador ou intérprete. Eles são apenas para leitores humanos para entender melhor o código. Diferentes linguagens de programação usam sintaxe diferentes para comentários:
*
Comentários de linha única: Eles comentam uma única linha de código. Exemplos incluem:
* `// Este é um comentário de linha única em C ++, Java, JavaScript e muitos outros.
* `# Este é um comentário de linha única em Python, Ruby e Bash.
*
Comentários de várias linhas (comentários do bloco): Eles comentam várias linhas de código. Exemplos incluem:
* `/* Este é um comentário de várias linhas em C, C ++, Java e outros.
Pode abranger várias linhas. */`
* `'' 'Este é um comentário de várias linhas no Python.
Também pode abranger várias linhas. '' '`
* `" "" Este é outro estilo de comentário de várias linhas em Python. "" "` `
O objetivo dos comentários é:
*
Explique o objetivo do código: Descreva o que uma função, classe ou bloco de código faz.
*
esclarecer a lógica complexa: Divida os algoritmos complicados ou pisos em peças menores e compreensíveis.
*
Documentar suposições e limitações: Observe quaisquer restrições ou condições sob as quais o código opera.
*
Forneça contexto: Explique o raciocínio por trás de determinadas opções de design.
*
Deixe as notas para futuras modificações: Facilite para os outros (ou a si mesmo no futuro) entender e manter o código.
Os comentários bem escritos são cruciais para a legibilidade do código, a manutenção e a colaboração. O excesso de compensação (comentando sobre código óbvio) geralmente é desencorajado, pois pode desordenar o código e dificultar a leitura. O objetivo é agregar valor ao entendimento do código, não reafirmar o que já está claro.
