Changes between Version 27 and Version 28 of GoodCodeExamples

Timestamp:

05/20/09 17:14:46 (16 years ago)

Author:

meddle

Comment:

--

GoodCodeExamples

@@ -286 +286 @@
   * 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:
+   * Method:
 {{{
         /*
@@ -297 +298 @@
          */
 }}}
+   * Class:
+{{{
+/**
+ * A class representing a given aspect of a given {@link BasePro}.
+ * Currently used only with {@link BaseProList}s.
+ *
+ * {@link Aspect}s can be used by {@link BasePro}s internally to reduce the attached listeners
+ * and the registered reads.
+ * 
+ * This way:
+ * 1) Some reads could be registered not with the {@link BasePro} itself but with an {@link Aspect}
+ * of the {@link BasePro}, and so potentially lots of listeners will be attached to the
+ * {@link Aspect}s, instead of the {@link BasePro}.
+ * 2) ProChanges will be fired from the {@link Aspect}s of the {@link BasePro} to registered
+ * listeners, instead of always firing from the {@link BasePro} itself. 
+ * 
+ * @author gogov
+ */
+}}}