Comments

Probably the simplest form of code is a comment. Comments can be used to structure your program and enhance its human readability. There are two main types of comments.

Usage

Single-Line Comments

These comments are best utilized for commenting out existing code. The entire line following the -- will become a comment.

-- this is a comment

Using single-line comments for purposes other than quickly commenting out code is not recommended! The -- symbol only initiates a comment when used at the very beginning of the line. It is considered best practice to utilize multi-line comments whenever possible.

Multi-Line Comments

A much better way to use comments is with multi-line comments. Anything between /* and */ will be considered a comment.

/* this is a comment */

/*
this is also a comment
*/

In the next chapter, we will learn about variables.