Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add description for XXX comment tag

...

  • the TODO is all capitalized
  • first letter of TODO message does not need to be upper-case
  • there is no colon or dash char after TODO
  • there is no period at the end
  • description is short (70 chars or less if possible) and helpful
  • the TODO message describes an action that needs to be performed in the future

XXX comments

Example of XXX:

Code Block

  // XXX Hazardous code! We should find a way to make
  //     it more secure

Notice the format:

  • the XXX is all capitalized
  • there is no colon or dash char after XXX
  • there is no period at the end
  • description is short (70 chars or less if possible) and helpful
  • the XXX is used to warn other programmers of problematic or misguiding code.