| author | Oleksandr Gavenko <gavenkoa@gmail.com> |
| Sat, 10 Feb 2018 01:36:16 +0200 | |
| changeset 2229 | 1a0b6597e594 |
| parent 2228 | 837f1337c59b |
| permissions | -rw-r--r-- |
|
1334
9bf0d5a1f0cf
Include common header with quick links.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
920
diff
changeset
|
1 |
.. -*- coding: utf-8; -*- |
| 918 | 2 |
|
3 |
==================== |
|
4 |
TODO like keywords |
|
5 |
==================== |
|
6 |
.. contents:: |
|
|
1905
fba288d59662
Include only local subsections into TOC. This prevent duplication of
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1334
diff
changeset
|
7 |
:local: |
| 918 | 8 |
|
9 |
Existing resources. |
|
10 |
=================== |
|
11 |
||
|
2228
837f1337c59b
Removed indentation that compiled into <blockquote>.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1912
diff
changeset
|
12 |
http://www.python.org/dev/peps/pep-0350/ |
|
837f1337c59b
Removed indentation that compiled into <blockquote>.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1912
diff
changeset
|
13 |
Codetags |
|
837f1337c59b
Removed indentation that compiled into <blockquote>.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1912
diff
changeset
|
14 |
http://tracos.org/codetag/ |
|
837f1337c59b
Removed indentation that compiled into <blockquote>.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1912
diff
changeset
|
15 |
This project aims to provide a Toolset and RFC-style Pep usage |
|
837f1337c59b
Removed indentation that compiled into <blockquote>.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1912
diff
changeset
|
16 |
convention for Codetags. |
|
837f1337c59b
Removed indentation that compiled into <blockquote>.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1912
diff
changeset
|
17 |
http://java.sun.com/docs/codeconv/html/CodeConventions.doc9.html#395 |
|
837f1337c59b
Removed indentation that compiled into <blockquote>.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1912
diff
changeset
|
18 |
Code Conventions for the Java TM Programming Language. |
|
837f1337c59b
Removed indentation that compiled into <blockquote>.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1912
diff
changeset
|
19 |
Programming Practices |
|
837f1337c59b
Removed indentation that compiled into <blockquote>.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1912
diff
changeset
|
20 |
http://c2.com/cgi/wiki?FixmeComment |
|
837f1337c59b
Removed indentation that compiled into <blockquote>.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1912
diff
changeset
|
21 |
Fixme Comment |
| 918 | 22 |
|
23 |
FIXME |
|
24 |
===== |
|
25 |
||
26 |
For things which are definitely broken, but where you want to not worry about |
|
27 |
it for the moment. |
|
28 |
||
|
919
7270274e29a3
Add tips from Code Conventions for the Java TM Programming Language.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
918
diff
changeset
|
29 |
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
|
30 |
|
| 918 | 31 |
TODO |
32 |
==== |
|
33 |
||
34 |
For useful features, optimizations or refactorings that might be worth doing |
|
35 |
in the future. |
|
36 |
||
37 |
TODO used to justify not completing code at the time it is first written. |
|
38 |
||
39 |
XXX |
|
40 |
=== |
|
41 |
||
|
919
7270274e29a3
Add tips from Code Conventions for the Java TM Programming Language.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
918
diff
changeset
|
42 |
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
|
43 |
|
| 918 | 44 |
For things that require more thought and that are arguably broken. |
45 |
||
46 |
An XXX demands attention and is not intended to stay in the code long. We may |
|
47 |
later decide that no problem exists. Or we may need to document unexpected |
|
48 |
behavior. If code is broken, we do not expect it to stay that way. We mark the |
|
49 |
problem immediately so that it is not forgotten. |
|
50 |
||
51 |
BUG |
|
52 |
=== |
|
53 |
||
54 |
BUG [ID бага] – обозначает, что в коде есть известный баг, который ещё не исправлен. |
|
55 |
REVIEW |
|
56 |
BROKEN |
|
57 |
HACK |
|
58 |
||
59 |
TRICKY |
|
60 |
====== |
|
61 |
||
62 |
Говорит о том, что код является мудрёным и нужно хорошо подумать прежде чем |
|
63 |
что-то в нём менять. |
|
64 |
||
65 |
WARNING |
|
66 |
======= |
|
67 |