WDD 130: Web Fundamentals

W03 Learning Activities: Code Comments

Overview

Comments written in code by developers provide a way to explain the purpose and function of that code. Since the code will need to be maintained and will change, comments can serve as reminders, 'to do' lists, code snippets, and notes for potential improvement during development. Comments are not processed or displayed to the user in the rendered document in HTML or CSS. Comments can be placed in any available white space.

Prepare

• HTML comments are not rendered in the browser.
  Here is an HTML comment syntax example:

  <!-- This is an HTML comment -->

  Reference: HTML Comments – MDN
• CSS comments have no effect on the layout or presentation of a document.
  Here is a CSS comment syntax example:

  /* This is a comment */

  Reference: CSS Comments – MDN
• Use comments in your learning activities and assignments to remind yourself of things you want to reference or document for future use. While these comments are for your personal use, keep in mind that organizations may have specific commenting requirements given many developers might work on a project over its lifetime.
• The concept of comments is also used in your git commits which, are especially useful for tracking revision history and providing context to your commits for your development team.

Activity Instructions

1. Open any HTML or CSS document in VS Code.
2. Use ctrl+/ (Mac ⌘+/) to comment out the line of code where you cursor is currently located or lines of code that you have selected.
3. Pressing ctrl+/ again will toggle the commented out line(s) of code.