Page History

...

There are three types of comments that may be used in PHP. They are block comments (/* */), inline comments (//), and shell comments (#).

Block Comments

Block comments are used for doc commenting, commenting out large sections of code. Blesta uses PHPDoc syntax for all doc comments. Block comments may not be used as a substitute for inline comments.

/*
This is a comment.
*/
if ($foo > $bar) {
    return $bar
}

/**
 * This is a DocBlock comment 
 */ 
function foo() {

}

Inline Comments

Inline comments should be used to clarify code. You are discouraged from using inline comments at the end of a line as this creates run-on lines and your comment is unlikely to be read.

/*
Calculate the circumference
*/
$c = 2*pi()*$r;

$c = 2*pi()*$r; // Calculate the circumference

// Calculate the circumference
$c = 2*pi()*$r;

...

Shell Comments

These comments should only be used to identify TODO comments.

...