Changes between Version 73 and Version 74 of DeveloperGuidelines/CodeConventions

Timestamp:

01/22/18 21:56:43 (8 years ago)

Author:

Dominic König

Comment:

--

DeveloperGuidelines/CodeConventions

@@ -78 +78 @@
 }}}
 
+ * Add comments so others can understand your code when they try to find bugs or improve/extend it
+ * Comments in code should explain intent (or clarify techniques), not repeat the code (do not explain what is self-explaining)
+
+Poor:
+{{{
+# Set free to True
+free = True
+}}}
+
+Good:
+{{{
+# Indicate that the position is now free
+free = True
+}}}
+
+ * Commented code should have a comment explaining why it is commented
+
+Unclear:
+{{{
+#result = somefunction(somearg)
+result = 0
+}}}
+
+Better:
+{{{
+# Not working yet, @todo: fix somefunction
+#result = somefunction(somearg)
+result = 0
+}}}
 === Internationalisation ===