CodeTags или какие ещё бывают TODO.

http://legacy.python.org/dev/peps/pep-0350/

TODO (MILESTONE, MLSTN, DONE, YAGNI, TBD, TOBEDONE)
    To do: Informal tasks/features that are pending completion.
FIXME (XXX, DEBUG, BROKEN, REFACTOR, REFACT, RFCTR, OOPS, SMELL, NEEDSWORK, INSPECT)
    Fix me: Areas of problematic or ugly code needing refactoring or cleanup.
BUG (BUGFIX)
    Bugs: Reported defects tracked in bug database.
NOBUG (NOFIX, WONTFIX, DONTFIX, NEVERFIX, UNFIXABLE, CANTFIX)
    Will Not Be Fixed: Problems that are well-known but will never be addressed due to design problems or domain limitations.
REQ (REQUIREMENT, STORY)
    Requirements: Satisfactions of specific, formal requirements.
RFE (FEETCH, NYI, FR, FTRQ, FTR)
    Requests For Enhancement: Roadmap items not yet implemented.
IDEA
    Ideas: Possible RFE candidates, but less formal than RFE.
??? (QUESTION, QUEST, QSTN, WTF)
    Questions: Misunderstood details.
!!! (ALERT)
    Alerts: In need of immediate attention.
HACK (CLEVER, MAGIC)
    Hacks: Temporary code to force inflexible functionality, or simply a test change, or workaround a known problem.
PORT (PORTABILITY, WKRD)
    Portability: Workarounds specific to OS, Python version, etc.
CAVEAT (CAV, CAVT, WARNING, CAUTION)
    Caveats: Implementation details/gotchas that stand out as non-intuitive.
NOTE (HELP)
    Notes: Sections where a code reviewer found something that needs discussion or further investigation.
FAQ
    Frequently Asked Questions: Interesting areas that require external explanation.
GLOSS (GLOSSARY)
    Glossary: Definitions for project glossary.
SEE (REF, REFERENCE)
    See: Pointers to other code, web link, etc.
TODOC (DOCDO, DODOC, NEEDSDOC, EXPLAIN, DOCUMENT)
    Needs Documentation: Areas of code that still need to be documented.
CRED (CREDIT, THANKS)
    Credits: Accreditations for external provision of enlightenment.
STAT (STATUS)
    Status: File-level statistical indicator of maturity of this file.
RVD (REVIEWED, REVIEW)
    Reviewed: File-level indicator that review was conducted.
Отправить комментарий

Популярные сообщения из этого блога

Дневник канадского иммигранта (humour detected)

Популярные словечки в веб разработке