Fav

It's a useful website for webmaster!

php comments example

<?php
#-------------1.文档注释-------------

/**
 * 这是一个php标注注释的样例文件的标题
 *
 * 样例文件的说明。样例文件为大家提供一个基本的样例,以后大家写注释可以参考这格式做。否则将要被领导惩罚买水果.
 * 所有以#开头后的文字都是注释的注释,在具体编码中可以删除
 *
 * @author 时永旺 <shiyongwang@aspirehld.com> #文件作者,语法:@author [name] [<email address>]
 * @copyright Copyright (c) 卓望公司 2000-2013. (http://www.aspirecn.com/) #版权所有,语法:@copyright [description]
 * @version 1.0 迎春花 #版本号,语法:@version [<vector>] [<description>]
 * @license http://www.aspirecn.com/soft/license.html GNU Public License #使用许可,语法:@license [<url>] [name]
 * @link http://weibo.10086.cn 文件的使用地址 #外链说明,语法:@link [URI] [<description>]
 * @package Http\Client\Sars #所在包,语法:@package [level 1]\[level 2]\[etc.]
 * @subpackage Http_Client #子包,语法:@subpackage [name]
 */


#-------------2.定义一个常量(宏),此常量为字符串类型-------------
/**
 * 移动微博的服务器地址
 * @var string
 */
define('WEIBO_SERVER''http://weibo.10086.cn/');

#-------------3.定义一个常量(宏),此常量为布尔类型-------------
/**
 * 是否直接在页面里输出错误信息
 * @var bool
 */
define('IS_OUTPUT_ERROR'FALSE);



#-------------4.定义一个函数(只有一个参数)-------------
 /**
 * 根据用户id获取用户信息,包含头像,性别等全部资料
 *
 * @uses $pdo 数据库链接对象 #需要使用全局变量,语法:@uses $var [<description>]
 *
 * @param int $userId 用户id
 * @return array|bool 获取用户信息失败,则返回FALSE #函数返回值,语法:@return [Type] [<description>]
 */
function getUserById($userId)
{
    global 
$pdo;
    
$info $pdo->getOne();
    if(!
$info)
    {
        return 
FALSE;
    }
    
tinyUserInfo($info); //格式化并整理补充用户信息
    
return $info
}

#-------------4.定义一个函数(使用多个参数,有默认参数)-------------
 /**
 * 获取一组用户信息
 * 批量获取组用户信息,如果翻页过大,返回的数据可能是一个空数组
 *
 * @since 0.82 增加$isTiny参数 #从大到小的先后顺序依次排列
 * @since 0.71 新增此函数 #在某个版本干了什么事情,语法:@since [version] [<description>]
 *
 * @uses $pdo 数据库链接对象 #需要使用全局变量,语法:@uses $var [<description>]
 *
 * @param int $size 每次获取数量
 * @param int $start 从哪个页数获取
 * @param [bool $isTiny=TRUE] 是否整理用户信息,可选参数,默认为真
 * @return array|bool 成功后返回用户信息数组
 */
function getUserById($size$start$isTiny TRUE)
{
    global 
$pdo;
    
$infoList $pdo->getAll();
    if(!
$infoList)
    {
        return 
FALSE;
    }
    if(
$isTiny)
    {
        
//遍历所有用户信息,当个整理
        //注意:这是需要使用引用
        
foreach($infoList as &$info)
        {
            
tinyUserInfo($info); //格式化并整理补充用户信息
        
}
    }
    return 
$info
}

#-------------5.定义一个类-------------

class ChinaPeople
{
    const 
SEX_MAN  1// 男人的性别
    
const SEX_WOMAN  2// 女人的性别

    /**
    * 用户允许结婚的年龄
    * @var int
    * @access private
    * @static
    */
    
static private $_marryAge 22;

    
/**
     * 生一个孩子
     *
     * 中国人生一个孩子。生玩之后,会产生一个ChinaPeople对象
     *
     * @access public
     * @version 2.8.0
     */
    
static public function born()
    {
        return new 
ChinaPeople();
    }

    
/**
    * 用户年龄
    * @var int
    * @access private
    */
    
private $_age 28;


    
/**
    * 用户身高
    * @var int
    * @access public
    */
    
public $height 180;

    
/**
     * 构造函数,生成一个对象时,需要做的处理动作
     *
     * @return void
     */
    
public function __construct()
    {
    }


    
/**
     * 结婚方法
     * 一个人像另一个人求婚
     * Also results in same content as you started with after decoding
     * @see propose()
     * @access public
     * @param object $peopleObject 一个人对象
     * @param string $date 结婚日期
     * @param [int $time=11] 婚礼举行日期.默认12点举行
     * @return bool
     * @throws AgeException 用户年龄不合法 #抛出异常,语法:@throws [Type] [<description>]
     * @author 时永旺
     */
    
public function marry($peopleObject$date$time 11)
    {
        if(
this._age self::$_marryAge)
        {
            throw new 
AgeException('用户未到婚龄'101);
        }

        if(
this.propose() && $peopleObject.allow())
        {
            return 
TRUE;
        }
    }
}

#-------------6.页码代码-------------
//引用初始化文件
require 'init.php';

//生成一个时永旺对象,并赋值他的身高
$syw = new ChinaPeople();
$syw->height 178;