code comments
[koʊd ˈkɑːmɛnts]
nounpl: code comments
comentários de código
1. Annotations or explanatory text written by programmers within source code that are ignored by the compiler or interpreter, used to explain the purpose, logic, or functionality of code sections
The developer added code comments to explain the complex algorithm to future maintainers.
O desenvolvedor adicionou comentários de código para explicar o algoritmo complexo para futuros mantenedores.
2. Non-executable lines in a program that document the code's intent, implementation details, or usage instructions
Good code comments make the codebase more maintainable and easier to understand.
Bons comentários de código tornam a base de código mais fácil de manter e entender.
3. Text preceded by special syntax (such as // or /* */) that serves as documentation within a program file
Every function should include code comments describing its parameters and return values.
Cada função deve incluir comentários de código descrevendo seus parâmetros e valores de retorno.
In both Brazilian and American software development cultures, code comments are considered essential best practice. Brazilian tech companies emphasize 'comentários de código' as a quality assurance measure, often required in code reviews. In the USA, there's a cultural debate about over-commenting versus writing self-explanatory code, with many following the principle that code should be 'self-documenting' with minimal comments needed.
Look up more words on Fala2Me
The free English-Portuguese dictionary with real Brazilian accents, NYC slang, conjugator and more
Open Fala2Me →