Use MAJOR Comments to Both Summarize and Communicate Intent [DS3] [WHAT] [WHY]
Tip DS3
Many people often have repetitious MAJOR comments that simply restate the code without providing more information. It is often possible for you to have effective summary comments that ALSO express intent. Strive to do this.
Summarizing code with a single comment is valuable because it provides a way to concisely understand many lines via a single line. However, commenting on intent is even more valuable because it communicates key information not available from the code itself.
The following examples show multiple ways that MAJOR comments can both summarize and communicate intent:
