devel-codetags.rst
changeset 918 bab1d4bfd0c9
child 919 7270274e29a3
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/devel-codetags.rst	Wed Aug 03 14:33:33 2011 +0300
@@ -0,0 +1,55 @@
+.. -*- coding: utf-8 -*-
+
+====================
+ TODO like keywords
+====================
+.. contents::
+
+Existing resources.
+===================
+
+  http://www.python.org/dev/peps/pep-0350/
+                Codetags
+  http://c2.com/cgi/wiki?FixmeComment
+
+FIXME
+=====
+
+For things which are definitely broken, but where you want to not worry about
+it for the moment.
+
+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
+===
+
+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
+=======
+