Changes between Version 1 and Version 2 of JAVADOC_CONVENTIONS

Timestamp:

09/16/08 17:43:15 (17 years ago)

Author:

Tanya

Comment:

--

JAVADOC_CONVENTIONS

@@ -19 +19 @@
   *@param - one for each parameter in the order of appearance in the method declaration. Should be stated what is the parameter meaning, its usage, preconditions about it, whether it is modified or not, if it could be null, etc.
   *@return - description of the return value, with focus on different return values such as errors or branch scenarios (e.g. when true, when false).
-  *@throws (or @exception - both are equivalent) - one for each checked exception (those that extend from Exception). There should be clearly stated in what cases the exceptions appear. There may be @throws for unchecked exceptions (that extend RuntimeException and Error), but this is not encouraged - only if the developer considers it very important to notify for an unchecked exception.
+  *@throws (or @exception - both are equivalent) - one for each checked exception (those that extend from Exception). There should be clearly stated in what cases the exceptions appear. There may be @throws for unchecked exceptions (that extend !RuntimeException and Error), but this is not encouraged - only if the developer considers it very important to notify for an unchecked exception.
   *There could be other tags in the following order (@author - not encouraged in Sophie-JR; @version - repository revision, not encouraged; @see class name; @since tag in which appears, not encouraged; @depracated - nice style is to provide @see or @link tag to the method to be used instead.)
  * Classes: brief and informative description of what the class does. There could be also sample usage added. Not tags are compulsory.
@@ -32 +32 @@
 
 ''' Notes on style '''
- * <code>ClassName</code> may be used when class names or method names are referred.
+ * <code>!ClassName</code> may be used when class names or method names are referred.
  * "this" keyword (not the, or the object) should be used when referring to the object in use.
  * when referring to another method no parentheses should be used (e.g. ...the add method...), except an exact argument list is provided  (e.g. ...the add(int x, int y) method...)