Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is the meaning of #XXX in code comments?

Tags:

comments

I have seen this a lot in code, even vim marks it as a special case. #TODO and #FIXME are two other fix markers vim highlights but what does #XXX mean?

like image 406
Jorge Vargas Avatar asked Sep 21 '09 04:09

Jorge Vargas


People also ask

What is the meaning of :/?

What Does :/ Mean? :/ is an emoticon used to indicate indecision, skepticism, exasperation, and annoyance. The emoticon :/ is one of the most difficult to define. It can indicate a wide range of emotions, including (but not limited to) indecision, skepticism, exasperation, and annoyance.

What is a number of meaning?

Definition of a number of : more than two but fewer than many : several There are a number of different options to choose from.


1 Answers

XXX in a comment is usually a heads-up. It could be:

  • Something that's not implemented completely correctly.
  • Something that should be fixed later on.
  • Highlighting a possible problem spot.
  • Something you're not sure about, a question.

I've often preferred a more descriptive tag like FIXME or TODO or HACK. XXX is often used as a catch all for the above.

Searching for 'XXX' on the FreeBSD code cross reference is a good example of many of the uses. There are thousands...

like image 145
Stef Avatar answered Oct 22 '22 03:10

Stef