Where does the TODO convention come from?

coding-style convention todo
Richard picture Richard · Feb 29, 2012 · Viewed 13.2k times · Source

I suspect this question has been asked before, but it's not easy to Google for.

I am a fairly new coder and I see a lot of code, in a lot of different languages, with comments beginning "TODO".

Questions:

  • Is there a practical reason why people write TODO in all these different languages, or is it merely a convention?
  • If the latter, where did the convention come from?

I can see why it's useful to be able to grep for TODO, I'm just curious about the history behind it.

Answer

sarnold picture sarnold · Feb 29, 2012

Programming is a world-wide activity; conventions to help smooth the process of working with people who are not native speakers of each other's languages are worth their weight in gold. TODO and XXX are often highlighted by IDEs, which provides an excellent incentive to stick with these options.

XXX suggests a danger or hazard that maintenance programmers must be aware of; TODO explains shortcomings that would be nice to address.

Related questions

What does it mean when a variable equals a function?

Possible Duplicate: JavaScript: var functionName = function() {} vs function functionName() {} In JavaScript, what's the purpose of defining a variable as a function? I've seen this convention before and don't fully understand it. For example, at some point in a script, a …

Read More
Python - most convenient way to define constant variables used just once

Let's say I have a file "icon.ico" and an url "url.com". The'll be used just once within the class - "icon.ico" will be set to some window and we'll do the request to url in one method. …

Read More
How to set Emacs tabs to spaces in every new file?

I would like to have an .emacs setting so that tabs are always formed by consecutive spaces. Preferably in each possible mode. In other editors it never seemed a problem, but in .emacs I'm a bit stuck with the tabs …

Read More