Okuzeka
Software Engineering vocabulary · Programming Concepts

Comment

Meaning in software engineering, with examples

/ˈkɑːment/nounCore term

In software engineering, comment means: A note inside the code that the computer ignores, written to explain to other developers why something is done. Remarks left in a code review are also called comments.

In Turkish: yorum, yorum satırı, kod yorumu

How it is used

Good comments explain why, not what. You add, leave or remove a comment. 'Comment out' means turning a line of code into a comment so that it does not run. In reviews: 'I left a few comments on your PR.'

Example sentences

  1. Could you add a comment explaining why we retry three times here?

  2. I commented out the old check, but we should delete it before merging.

Common collocations

  • add a comment
  • leave a comment
  • comment out
  • inline comment
  • TODO comment
  • documentationWritten material that explains how software works and how to use, set up or change it, such as guides, API references and README files.
  • code reviewThe practice of teammates reading and commenting on each other's code changes before they are merged, to catch problems and share knowledge.
  • readableEasy for another person to read and understand quickly, thanks to clear names, a simple structure and short functions.
  • clean codeCode that is simple, clearly named, well organized and easy for others to read, test and change, rather than code that only works.

This word in other fields

The same English word can have a different meaning in another field:

More terms: Programming Concepts

Practise with graded reading

Reading at the right level is the fastest way to make new words stick. Pick free English books by level: