Differences

This shows you the differences between two versions of the page.

--- guides:programstyle:comments [2020/08/18 11:36] – [Comment Contents] wikiadmin
+++ guides:programstyle:comments [2024/07/25 15:01] (current) – external edit 127.0.0.1
@@ Line 103: / Line 103: @@
        cout << endl;    // done with output, print an endl
 </code>
+Use comments to supplement the understanding of major sections of code.  Only rarely should comments be used on every line of code.  The following is not an acceptable use of documentation.
+<code c++>
+// Get the noun from the user
+noun = GetWord("a noun");
+// Get the adjective from the user
+adjective = GetWord("an adjective");
+// Get the action verb from the user
+actionVerb = GetWord("an action word");
+</code>
+The code above is mostly self documenting due to identifier choice, so a single comment would be more appropriate
+<code c++>
+// Get the words from the user
+noun = GetWord("a noun");
+adjective = GetWord("an adjective");
+actionVerb = GetWord("an action word");
+</code>
 Finally, most comments in code should employ a c++ style line comment.  This allows the programmer to comment out large blocks of code with c style comments.