1.2-1项目规范- 注释规范

注释一个良好习惯，往往在写完代码一个月之前，再回头看之前的代码，都不知道当时的思路，所以只有以注释的方式记录或解释

以下时一些通用注释标签,这些标签以后用phpdocumentor 导出html 格式,phpdoc 标签

http://pear.php.net/package/PhpDocumentor/docs/latest/li_phpDocumentor.html

@access 
使用范围：class,function,var,define,module 
该标记用于指明关键字的存取权限：private、public或proteced 
@author 
指明作者 
@copyright 
使用范围：class，function，var，define，module，use 
指明版权信息 
@deprecated 
使用范围：class，function，var，define，module，constent，global，include 
指明不用或者废弃的关键字 
@example 
该标记用于解析一段文件内容，并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容 
@const 
使用范围：define 
用来指明php中define的常量 
@final 
使用范围：class,function,var 
指明关键字是一个最终的类、方法、属性，禁止派生、修改。 
@filesource 
和example类似，只不过该标记将直接读取当前解析的php文件的内容并显示。 
@global 
指明在此函数中引用的全局变量 
@ingore 
用于在文档中忽略指定的关键字 
@license 
相当于html标签中的<a>,首先是URL，接着是要显示的内容 
例如<a href=”http://www.baidu.com”>百度</a> 
可以写作 @license http://www.baidu.com 百度 
@link 
类似于license 
但还可以通过link指到文档中的任何一个关键字 
@name 
为关键字指定一个别名。 
@package 
使用范围：页面级别的-> define，function，include 
类级别的->class，var，methods 
用于逻辑上将一个或几个关键字分到一组。 
@abstrcut 
说明当前类是一个抽象类 
@param 
指明一个函数的参数 
@return 
指明一个方法或函数的返回指 
@static 
指明关建字是静态的。 
@var 
指明变量类型 
@version 
指明版本信息 
@todo 
指明应该改进或没有实现的地方 
@throws 
指明此函数可能抛出的错误异常,极其发生的情况 
上面提到过，普通的文档标记标记必须在每行的开头以@标记，除此之外，还有一种标记叫做inline tag,用{@}表示，具体包括以下几种： 
{@link} 
用法同@link 
{@source} 
显示一段函数或方法的内容

1 单行注释

//下面定义一个变量

$_name = "xxx";

2 多行注释

/*
 * 凭证中借扣款 贷 还款
*/

3 文档注释

/**
 * 多行注释和文档注释初看起来没有什么不同，但是文档注释多了一个*号。但是PHP会以不同的方式来解析多行注释和文档注释。
*/

1 变量注释

   全局变量:

   全局变量:
   //@global 网站域名/首页
  $_WEB_URL = "http://www.baidu.com";
  //用户名赋值
  $_username = 'xxxx'

 

2 函数注释

/**
 * 图片相对地址转换成带http 的网址
 * @author admin
 * @param string $path 图片相对地址
 * @return string
 */
function showurl($path){
$url = C("UPLOAD_URL").$path;
return $url;
}

3 类注释

/**
 * B2B BasicAction 控制器基类
 * @category Action
 * @author Administrator
 *
 */

class BasicAction extends Action

{

}

4 类属性注释

class HetongModel extends BasicModel

{

// 视图实例对象
    protected $view   =  null;
    // 当前Action名称
    private $name =  '';

}

5 类方法注释

     /**
     * 模板显示
     * 调用内置的模板引擎显示方法，
     * @access protected
     * @param string $templateFile 指定要调用的模板文件
     * 默认为空 由系统自动定位模板文件
     * @param string $charset 输出编码
     * @param string $contentType 输出类型
     * @return void
     */
    protected function display($templateFile='',$charset='',$contentType='') {
        $this->view->display($templateFile,$charset,$contentType);
    }

6 php 文件注释

common.php

/**
  +------------------------------------------------------------------------------
 * Think 基础函数库
  +------------------------------------------------------------------------------
 * @category   Think
 * @package  Common
 * @author   liu21st <liu21st@gmail.com>
 * @version  $Id: common.php 2799 2012-03-05 07:18:06Z liu21st $
  +------------------------------------------------------------------------------
 */