What is the meaning of #XXX in code comments?

前端 未结 10 756
轮回少年
轮回少年 2020-12-12 09:29

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

10条回答
  •  难免孤独
    2020-12-12 10:11

    Some notes from a June 2005 Python Enhancement Proposal that was rejected.

    Choosing between FIXME and XXX is difficult.
    XXX seems to be more common, but much less descriptive.
    Furthermore, XXX is a useful placeholder in a piece of code
    having a value that is unknown.

    Thus FIXME is the preferred spelling.
    Sun says that XXX and FIXME are slightly different, giving XXX higher severity.
    However, with decades of chaos on this topic, and too many millions of
    developers who won't be influenced by Sun, it is easy to rightly call them synonyms.


    The PEP Starts with,

    This PEP has been rejected. While the community may be interested,
    there is no desire to make the standard library conform to this standard.

    ...

    What Are Codetags?

    Programmers widely use ad-hoc code comment markup conventions to serve as reminders of sections of code that need closer inspection or review. Examples of markup include FIXME, TODO, XXX, BUG, but there many more in wide use in existing software. Such markup will henceforth be referred to as codetags. These codetags may show up in application code, unit tests, scripts, general documentation, or wherever suitable.


    The PEP is an interesting read.

提交回复
热议问题