TODO comments in code - global-121/121-platform GitHub Wiki

TODO and XXX comments in code

A TODO comment in code is a one-line or inline comment that starts with TODO or some other string.

For example:

// TODO: add type checking
function add(a, b) {
  return a + b;
}

These types of comments are generally quite common in code. They're used in different ways but generally signify that something still needs to be done.

Block merging

In the 121-platform we currently (2025-09) use XXX: comments to mark code that needs to change before it's merged into main. Our Continuous Integration process will stop a pull request that tries to merge in code that has these comments.

Markers and their meanings

Other markers you can come across, in general, are:

  • TODO - Something that needs to be done
  • FIXME - Something that needs to be fixed
  • HACK - A workaround or temporary solution
  • NOTE - Important information
  • OPTIMIZE - Performance improvements needed
  • REVIEW - Code that needs review
  • BUG - Known bug that needs fixing
  • XXX - Critical warning or important issue