Add tips from Code Conventions for the Java TM Programming Language.
Programming Practices
--- a/devel-codetags.rst Wed Aug 03 14:33:33 2011 +0300
+++ b/devel-codetags.rst Wed Aug 03 14:48:16 2011 +0300
@@ -10,7 +10,11 @@
http://www.python.org/dev/peps/pep-0350/
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
=====
@@ -18,6 +22,8 @@
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
====
@@ -29,6 +35,8 @@
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