代码没有注释会不仅对后来者开发造成一定的影响，时间一长，自己也会犯迷糊，所以项目应该多写注释。
注释的原则是将问题解释清楚，并不是越多越好。
下面是php注释标记：
所有的文档标记都是在每一行的 * 后面以@开头。如果在一段话的中间出来@的标记，这个标记将会被当做普通内容而被忽略掉。
@access 该标记用于指明关键字的存取权限：private、public或proteced，使用范围：class,function,var,define,module
@author 指明作者
@copyright 指明版权信息
@const 使用范围：define 用来指明php中define的常量
@final 使用范围：class,function,var 指明关键字是一个最终的类、方法、属性，禁止派生、修改。
@global 指明在此函数中引用的全局变量
@name 为关键字指定一个别名。
@package 用于逻辑上将一个或几个关键字分到一组。
@abstrcut 说明当前类是一个抽象类
@param 指明一个函数的参数
@return 指明一个方法或函数的返回值
@static 指明关建字是静态的。
@var 指明变量类型
@version 指明版本信息
@todo 指明应该改进或没有实现的地方
@link 可以通过link指到文档中的任何一个关键字
@ingore 用于在文档中忽略指定的关键字
文件头部模板
/**
*这是一个什么文件
*
*此文件程序用来做什么的（详细说明，可选。）。
* @author 作者
* @version $Id$
* @since 1.0
*/
函数头部注释
/**
* 函数的含义说明
*
* @access public
* @param mixed $arg1 参数一的说明
* @param mixed $arg2 参数二的说明
* @param mixed $mixed 这是一个混合类型
* @since 1.0
* @return array
*/
public function thisIsFunction($string, $integer, $mixed) {
return array();
}
类的注释
/**
* 类的介绍
*
* 类的详细介绍（可选。）。
* @author 作者
* @since 1.0
*/
class Test
{
}
程序代码注释
1) 若干语句作为一个逻辑代码块，这个块的注释可以使用/* */方式。
2) 具体到某一个语句的注释，可以使用行尾注释：//。
/* 生成配置文件、数据文件。*/
$this->setConfig();
$this->createConfigFile(); //创建配置文件
$this->clearCache(); // 清除缓存文件
$this->createDataFiles(); // 生成数据文件
$this->prepareProxys();
$this->restart();