Changes between Version 30 and Version 31 of GoodCodeExamples

Timestamp:

05/20/09 17:26:02 (16 years ago)

Author:

meddle

Comment:

--

GoodCodeExamples

@@ -284 +284 @@
   * Add yourself to the author list when you modify the logic, if your changes do not alter the logic don't do it.
   * Write parameter descriptions on the next row.
+  * Use @see for methods or classes that are connected to your code.
+  * Use @since for comments of special changes since some date and write your identificator and the date.
+  * Use TODO, XXX and FIXME.
   * Write all the @parameter, @return, descriptions as a sentences which begin with upper case letter and end with a punctuation mark. Write the description itself of the javadoc even for getters and setters, write it as sentences!
   * Examples:
@@ -333 +336 @@
  */
 }}}
+ * Comments:
+  * Comment all the hard to understand algorithmic structure you write.
+  * Delete all the auto-generated Eclipse TODO comments.