| author | Oleksandr Gavenko <gavenkoa@gmail.com> |
| Wed, 03 Aug 2011 15:20:56 +0300 | |
| changeset 920 | 05c1d6ef107b |
| parent 919 | 7270274e29a3 |
| child 1334 | 9bf0d5a1f0cf |
| permissions | -rwxr-xr-x |
| 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 |
|
|
920
05c1d6ef107b
http://tracos.org/codetag/
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
919
diff
changeset
|
13 |
http://tracos.org/codetag/ |
|
05c1d6ef107b
http://tracos.org/codetag/
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
919
diff
changeset
|
14 |
This project aims to provide a Toolset and RFC-style Pep usage |
|
05c1d6ef107b
http://tracos.org/codetag/
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
919
diff
changeset
|
15 |
convention for Codetags. |
|
919
7270274e29a3
Add tips from Code Conventions for the Java TM Programming Language.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
918
diff
changeset
|
16 |
http://java.sun.com/docs/codeconv/html/CodeConventions.doc9.html#395 |
|
7270274e29a3
Add tips from Code Conventions for the Java TM Programming Language.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
918
diff
changeset
|
17 |
Code Conventions for the Java TM Programming Language. |
|
7270274e29a3
Add tips from Code Conventions for the Java TM Programming Language.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
918
diff
changeset
|
18 |
Programming Practices |
| 918 | 19 |
http://c2.com/cgi/wiki?FixmeComment |
|
919
7270274e29a3
Add tips from Code Conventions for the Java TM Programming Language.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
918
diff
changeset
|
20 |
Fixme Comment |
| 918 | 21 |
|
22 |
FIXME |
|
23 |
===== |
|
24 |
||
25 |
For things which are definitely broken, but where you want to not worry about |
|
26 |
it for the moment. |
|
27 |
||
|
919
7270274e29a3
Add tips from Code Conventions for the Java TM Programming Language.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
918
diff
changeset
|
28 |
Use FIXME to flag something that is bogus and broken. |
|
7270274e29a3
Add tips from Code Conventions for the Java TM Programming Language.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
918
diff
changeset
|
29 |
|
| 918 | 30 |
TODO |
31 |
==== |
|
32 |
||
33 |
For useful features, optimizations or refactorings that might be worth doing |
|
34 |
in the future. |
|
35 |
||
36 |
TODO used to justify not completing code at the time it is first written. |
|
37 |
||
38 |
XXX |
|
39 |
=== |
|
40 |
||
|
919
7270274e29a3
Add tips from Code Conventions for the Java TM Programming Language.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
918
diff
changeset
|
41 |
Use XXX in a comment to flag something that is bogus but works. |
|
7270274e29a3
Add tips from Code Conventions for the Java TM Programming Language.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
918
diff
changeset
|
42 |
|
| 918 | 43 |
For things that require more thought and that are arguably broken. |
44 |
||
45 |
An XXX demands attention and is not intended to stay in the code long. We may |
|
46 |
later decide that no problem exists. Or we may need to document unexpected |
|
47 |
behavior. If code is broken, we do not expect it to stay that way. We mark the |
|
48 |
problem immediately so that it is not forgotten. |
|
49 |
||
50 |
BUG |
|
51 |
=== |
|
52 |
||
53 |
BUG [ID бага] – обозначает, что в коде есть известный баг, который ещё не исправлен. |
|
54 |
REVIEW |
|
55 |
BROKEN |
|
56 |
HACK |
|
57 |
||
58 |
TRICKY |
|
59 |
====== |
|
60 |
||
61 |
Говорит о том, что код является мудрёным и нужно хорошо подумать прежде чем |
|
62 |
что-то в нём менять. |
|
63 |
||
64 |
WARNING |
|
65 |
======= |
|
66 |