.. -*- coding: utf-8; -*-
.. include:: HEADER.rst

====================
 TODO like keywords
====================
.. contents::

Existing resources.
===================

  http://www.python.org/dev/peps/pep-0350/
                Codetags
  http://tracos.org/codetag/
                This project aims to provide a Toolset and RFC-style Pep usage
                convention for Codetags.
  http://java.sun.com/docs/codeconv/html/CodeConventions.doc9.html#395
                Code Conventions for the Java TM Programming Language.
                Programming Practices
  http://c2.com/cgi/wiki?FixmeComment
                Fixme Comment

FIXME
=====

For things which are definitely broken, but where you want to not worry about
it for the moment.

Use FIXME to flag something that is bogus and broken.

TODO
====

For useful features, optimizations or refactorings that might be worth doing
in the future.

TODO used to justify not completing code at the time it is first written.

XXX
===

Use XXX in a comment to flag something that is bogus but works.

For things that require more thought and that are arguably broken.

An XXX demands attention and is not intended to stay in the code long. We may
later decide that no problem exists. Or we may need to document unexpected
behavior. If code is broken, we do not expect it to stay that way. We mark the
problem immediately so that it is not forgotten.

BUG
===

BUG [ID бага] – обозначает, что в коде есть известный баг, который ещё не исправлен.
REVIEW
BROKEN
HACK

TRICKY
======

Говорит о том, что код является мудрёным и нужно хорошо подумать прежде чем
что-то в нём менять.

WARNING
=======