注释语法

PHP注释有三种语法：

// 这样事单行注释

# 这样也是单行注释，但是很多教程里并没有说这种方式

/*
 * 这样是多行注释
 */

使用规范

很多教程里只会告诉我们怎么写就是注释，这样就不会被解释器解释运行，但是很少告诉我们怎样去规范的写注释。

根据被注释的对象：

也可能要给整个文件添加注释，记录这个文件的作者，创建时间，最后修改时间，这个文件的作用等信息；
还可以给一个类添加注释，记录这个类的介绍，作者，版本，最后修改日期等信息；
还可以给函数注释，记录函数的作用，参数，返回值，最后修改时间等信息；
我们可以给某一句或某一段代码的意思进行简单的说明，但是需要注意的是需要解释的才写注释，如果是人都能看懂的，还写个注释就有点多余了。
还可以在调试的时候给不想运行的代码进行注释，但是调试完了部署的时候尽量清理干净，因为以后的人会不知道这段代码的意思，还没人敢删。如果真的是有用的代码，那就说清楚这段代码的作用，然后留下。

标示	作用
access	该标记用于指明关键字的存取全权限。可以是：private，public，proteced。使用范围：class，function，var，define，module。
author	指明作者。
copyright	指明版权信息。
const	指明PHP中的define的常量。使用范围：define。
final	指明关键字是一个最终的类、方法、属性，禁止派生，修改。使用范围：class，function，var。
global	指明在此函数中引用的全局变量。
name	为关键字指明一个别名。
package	用于逻辑上将一个或几个关键字分到一组。
abstract	说明当前累是一个抽象类。
param	指明一个函数的参数。
return	指明一个函数的返回值。
static	指明关键字是静态的。
var	指明变量类型。
version	指明版本信息。
todo	指明应该改进或者没有实现的地方。
link	可以通过link指到文档中的任何一个关键字。
ignore	用于在文档中忽略制定的关键字。

示例

<?php
/**
 * 注释.php
 * 
 * 这个文档将会用一个Hello World程序来演示PHP文档的注释规范
 * 
 * @version 1.0 20181121
 * @author Gray Young
 * @package Hello
 */


/**
 * 包含文件
 */
 include_once 'unit.inc.php';

/**
 * 声明全局变量
 * @global integer $age
 */
$GLOBALS['age'] = 21;

/**
 * 声明全局常量
 * @const string $name
 */
define ('NAME', 'Gray Young');

/** 
 * Hello 
 * 
 * 对于我的基本信息的操作
 * 
 * @package Hello 
 * @subpackage Base
 */ 
class Hello
{
    /**
     * 声明变量
     * 
     * @access private
     * @var string
     */
    var $message = "";
    
    
    /** 
     * 创建构造函数 
     * @link $message
     */  
    function __construct() 
    {
        $this->message = "Hello";
    }
    
    /** 
     * 创建析构函数 
     * @link $message
     */ 
    function __destruct()
    {
        echo "\nBye~~";
    }
    
    /** 
     * get_message 
     * 
     * 输出$message 
     * 
     * @global integer $age 
     * @static var string $name 
     * @param string $language
     * @return string message
     */ 
    public function get_message($language)
    {
        switch ($language)
        {
            case 'Chinese':
                $this->message = "你好" . NAME . ",你今年" . $GLOBALS['age'] . "岁了。";
                break;
            case 'English':
                $this->message = "Hello " . NAME . ", Your are " . $GLOBALS['age'] . " years old.";
                break;
            default:
                $this->message = $language . "is not a available language";
        }
        return $this->message;
    }
}

$hello = new Hello();
$hello->get_message('Chinese');
echo $hello->message;