Kommentarregeln

Sd1/sd1.xml

@@ -438,7 +438,36 @@
       </listitem>
 
       <listitem>
-        <para>Repeating object inspection</para>
+        <para>Code conventions:</para>
+
+        <itemizedlist>
+          <listitem>
+            <para>Indentation</para>
+          </listitem>
+
+          <listitem>
+            <para>Capital/small letter conventions</para>
+          </listitem>
+
+          <listitem>
+            <para><code>snake_case</code> vs. <code>CamelCase</code>.</para>
+          </listitem>
+
+          <listitem>
+            <para>Comment formats <code>// this is a comment</code> and
+            <code>/* I like comments! */</code>.</para>
+          </listitem>
+
+          <listitem>
+            <para>Comment conventions / Comments and
+            <productname>Javadoc</productname></para>
+          </listitem>
+        </itemizedlist>
+      </listitem>
+
+      <listitem>
+        <para>Repeating object inspection in
+        <productname>Greenfoot</productname>.</para>
       </listitem>
     </itemizedlist>
 
@@ -593,7 +622,7 @@
                 compiler to share these three values among all possible crab
                 instances: They are being defined on class level rather than
                 on object (instant) level. Each crab may be i a different
-                state but there are only three possible state values </para>
+                state but there are only three possible state values</para>
               </callout>
             </calloutlist>
 
@@ -630,7 +659,8 @@
     </qandaset>
 
     <section xml:id="sw1Gf3.1">
-      <title><productname>Greenfoot</productname> 3.1</title>
+      <title><productname>Greenfoot</productname> 3.1, <quote>Adding random
+      behavior</quote></title>
 
       <itemizedlist>
         <listitem>
@@ -646,22 +676,22 @@
         </listitem>
 
         <listitem>
-          <para>Class methods vs. object methods / <code>static</code>
-          keyword.</para>
+          <para>Class methods and variables vs. object methods and variables:
+          The <code>static</code> keyword.</para>
         </listitem>
 
         <listitem>
-          <para>Class description object: <classname>java.lang.Class.
-          Qualification package.class.method.</classname></para>
+          <para>Class description object:
+          <classname>java.lang.Class</classname>.</para>
         </listitem>
 
         <listitem>
-          <para>Method comments</para>
+          <para>Qualification
+          <code>packagename.classname</code>.{method|variable}.</para>
         </listitem>
 
         <listitem>
-          <para>Convention: Methods start with lower case letters.
-          This_is_possible_as_well.</para>
+          <para>Method comments</para>
         </listitem>
       </itemizedlist>
     </section>
@@ -708,7 +738,7 @@
 
             <para>When approaching two worms at an identical position the
             instance variable <code>noOfWormsEaten</code> is being incremented
-            in two steps. </para>
+            in two steps.</para>
           </answer>
         </qandaentry>
       </qandadiv>