Short code comments can explain why a section exists or mark a task that still needs work. Future you—or a classmate—should understand the reason from the note.
What You Need to Know
Write comments about intent, not obvious details. Do not include private data, and do not leave outdated comments that disagree with the page.
The goal is not to collect as many tags as possible. Pick the element that best describes what the content really is.
Example: See It in Action
This example keeps the idea small. Copy it carefully, then follow the explanation instead of guessing what the browser will do.
This is a short HTML fragment. To try it as a webpage, put it inside the body element of a complete HTML document.
<!-- Keep headings in reading order. -->
<main>
<h1>Science fair</h1>
<!-- Add event details after confirmation. -->
<p>See you on Friday.</p>
</main>Let’s Understand the Example
- Main identifies the central content of the page; it should not be duplicated as separate visible main landmarks.
- An h1 introduces the main subject of the page. Use the heading level for structure rather than font size.
- A p groups a paragraph of related text. Start another paragraph for a new thought.
You should see a readable heading and its related content. The heading level tells readers how the ideas fit together, not merely how large the letters look.
What Should You See?
The page should display “Science fair” as a heading, followed by its related content. Change the heading text and refresh the browser to see the result.
Read only the headings, from top to bottom. Do they tell a sensible story? If not, move sections or choose levels that match the content.
Try It Yourself
- Write one comment that explains why a warning appears before a form.
- Save your changes, open or refresh the page, and compare the result with the original example.
- Tell a friend what your change did. If you are not sure, undo it, refresh the page, and compare.
Common Beginner Mistakes
- Commenting every closing tag instead of explaining a useful design decision.
- Avoid picking tags just for their default bold, italic or spaced appearance. Use CSS for presentation.
Key Takeaways
- Short code comments can explain why a section exists or mark a task that still needs work.
- Main identifies the central content of the page; it should not be duplicated as separate visible main landmarks.
- Write comments about intent, not obvious details. Do not include private data, and do not leave outdated comments that disagree with the page.