Hacker News new | past | comments | ask | show | jobs | submit login

I don't know if this is the exact incantation, but some IDE extensions will recognise some special comment annotations. TODO/FIXME support is in pretty much every IDE, but there are some special codes that some IDEs will recognise.

Visual Studio (not necessarily Code) will recognise TODO, HACK, NOTE and UNDONE, for example.

Java conventions mention XXX: https://www.oracle.com/java/technologies/javase/codeconventi...

    10.5.4 Special Comments
    
    Use XXX in a comment to flag something that is bogus but works. Use FIXME to flag something that is bogus and broken.

Using XXX in comments goes back to 1978, according to https://www.snellman.net/blog/archive/2017-04-17-xxx-fixme/

I'm not a huge fan of XXX as a warning, there are more descriptive names in caps available that your IDE will probably even autocomplete after using them for a while. However, the practice is common enough that it's just a General Programmer Thing, kind of like how some people prefer /* */ over // because they're just more used to it.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: