|
918
|
1 |
.. -*- coding: utf-8 -*-
|
|
|
2 |
|
|
|
3 |
====================
|
|
|
4 |
TODO like keywords
|
|
|
5 |
====================
|
|
|
6 |
.. contents::
|
|
|
7 |
|
|
|
8 |
Existing resources.
|
|
|
9 |
===================
|
|
|
10 |
|
|
|
11 |
http://www.python.org/dev/peps/pep-0350/
|
|
|
12 |
Codetags
|
|
|
13 |
http://c2.com/cgi/wiki?FixmeComment
|
|
|
14 |
|
|
|
15 |
FIXME
|
|
|
16 |
=====
|
|
|
17 |
|
|
|
18 |
For things which are definitely broken, but where you want to not worry about
|
|
|
19 |
it for the moment.
|
|
|
20 |
|
|
|
21 |
TODO
|
|
|
22 |
====
|
|
|
23 |
|
|
|
24 |
For useful features, optimizations or refactorings that might be worth doing
|
|
|
25 |
in the future.
|
|
|
26 |
|
|
|
27 |
TODO used to justify not completing code at the time it is first written.
|
|
|
28 |
|
|
|
29 |
XXX
|
|
|
30 |
===
|
|
|
31 |
|
|
|
32 |
For things that require more thought and that are arguably broken.
|
|
|
33 |
|
|
|
34 |
An XXX demands attention and is not intended to stay in the code long. We may
|
|
|
35 |
later decide that no problem exists. Or we may need to document unexpected
|
|
|
36 |
behavior. If code is broken, we do not expect it to stay that way. We mark the
|
|
|
37 |
problem immediately so that it is not forgotten.
|
|
|
38 |
|
|
|
39 |
BUG
|
|
|
40 |
===
|
|
|
41 |
|
|
|
42 |
BUG [ID бага] – обозначает, что в коде есть известный баг, который ещё не исправлен.
|
|
|
43 |
REVIEW
|
|
|
44 |
BROKEN
|
|
|
45 |
HACK
|
|
|
46 |
|
|
|
47 |
TRICKY
|
|
|
48 |
======
|
|
|
49 |
|
|
|
50 |
Говорит о том, что код является мудрёным и нужно хорошо подумать прежде чем
|
|
|
51 |
что-то в нём менять.
|
|
|
52 |
|
|
|
53 |
WARNING
|
|
|
54 |
=======
|
|
|
55 |
|