The DoYouHaoBaby PHP Framework For PHP5 | 中文开发文档手册

The DoYouHaoBaby PHP Framework中文开发文档手册
Copyright(c) DoYouHaoBaby.NET All Rights Reserved.

[ 变量或者语句注释 ]

程序中变量或者语句的注释遵循以下原则：

写在变量或者语句的前面一行，而不写在同行或者后面；
注释采用// 的方式；
每个函数前面要包含一个注释块。内容包括函数功能简述，输入/输出参数，预期的返回值，出错代码定义。
注释完整规范。
把已经注释掉的代码删除，或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。

例子：

/**
* 当前请求 URL 不包含查询参数的部分
*
* @access private
* @const
* @var string
*/
static private $_sBaseUrl;