Definition

Programmer-readable note that is inserted directly into the source code of the program. Gets ignored by the compiler

Trait

• Can be used for programmer to make their own notes in the source code without messing with it
• 2 Types of comment ;
  • Single-line comment (//) : Everything after this symbol gets ignored until the end of the line
  • Multi-line comment (/* paired with */) : Everything between these symbols are ignored

How to Use

• Use to describe what the library, program, or function does (Before/top of the file/code)
• Use to explain how the code going to accomplish the goal (Within the library, program, or function)
• Commenting out code to temporarily disable parts of your code

Examples on good usage;

// The player just drank a potion of blindness and can not see anything
sight = 0

Giving reason on why the code are doing the instruction

// We need to multiply quantity by 2 here because they are bought in pairs
cost = quantity * 2 * storePrice;

Giving explanation on why the formula is like that

// We decided to use a linked list instead of an array because
// arrays do insertion too slowly.

// We're going to use Newton's method to find the root of a number because
// there is no deterministic way to solve these equations.

Reminding or tell someone else for the decision made

Examples of bad comments;

// Set sight range to 0
sight = 0;

Obvious statements

// Calculate the cost of the items
cost = quantity * 2 * storePrice;