guides:programstyle:comments
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| guides:programstyle:comments [2020/08/18 11:38] – [Comment Placement in Code] wikiadmin | guides:programstyle:comments [2024/07/25 15:01] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 106: | Line 106: | ||
| 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. | 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++> | <code c++> | ||
| - | // Prompt | + | // Get the noun from the user |
| + | noun = GetWord(" | ||
| + | // Get the adjective from the user | ||
| + | adjective = GetWord(" | ||
| + | // Get the action verb from the user | ||
| + | actionVerb = GetWord(" | ||
| + | </ | ||
| + | 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(" | ||
| + | adjective = GetWord(" | ||
| + | actionVerb = GetWord(" | ||
| </ | </ | ||
guides/programstyle/comments.1597750732.txt.gz · Last modified: 2024/07/25 15:01 (external edit)