alignmentfixable

Ensure that docblocks asterisks are aligned

Examples

• Examples of correct code for this rule using default options

Docblock with aligned indent

<?php
/**
 * Log info.
 *
 * @param string $message Message to log
 * @return bool True on success, false on failure
 */
function log_info($message) {
	echo $message;
	return true;
}

/*
* Non-docblock comment will be ignored by this rule.
*/
function log_error($message) {
	echo $message;
	return true;
}

function function_with_no_docblock($message) {
	echo $message;
	return true;
}

class Test {
	/**
	 * @var array $data Data to log
	 */
    private $data = array();
	
    /**
     * Log info.
     *
     * @param string $message Message to log
     * @return bool True on success, false on failure
     */
	public function log_info($message) {
		echo $message;
		return true;
	}
}

• Examples of incorrect code for this rule using default options

Docblock with non-aligned indent

<?php
class Test{
	/**
	 * Log info.
	    *
	* @param string $message Message to log
	* @return bool True on success, false on failure
		*/
	function log_info($message) {
		echo $message;
		return true;
	}
}

	/**
  * Log error.
  *
  * @param string $message Message to log
  * @return bool True on success, false on failure
  */
function log_error($message) {
	echo $message;
	return true;
}

/**
  * Log info.
	 *
  * @param string $message Message to log
  * @return bool True on success, false on failure
  */
function log_info($message) {
	echo $message;
	return true;
}