Common Mistakes in Documentation and Commenting by Year 7 Students

1. Not Enough Comments

   • Almost half (47%) of Year 7 students don’t explain their complicated code well. This makes it hard to understand when others review the code.

2. Unhelpful Comments

   • About 35% of students write comments that don’t really help. For example, they repeat what the code does word-for-word. This just makes the code messier.

3. Inconsistent Comments

   • Only 25% of students use the same style for comments. This inconsistency makes it tough for others to read and figure out what the comments mean.

4. Not Updating Comments

   • 60% of students forget to change their comments when they change the code. This leads to confusion and makes it harder to fix problems later.

By improving these areas, students can make their code clearer and work better with their classmates.