PHP 注释标准
代码注释自己写代码好像一直没有标准的注释,自己看起来或许还没问题,但是在大的项目里面其他人看起来就费劲了
所以有详细的注释是必不可少的 (没详细 也要有一个大概的注释)
下面的内容就拿来做备忘吧 [坏笑/]
文件头部注释
/** * 说明文件内容 * * 详细说明 (选填) * @author 简爱<sc.419@qq.com> * @version 1.0 * @since 1.0 */
类与函数的注释
/** * 类的介绍 * * 类的详细介绍 (可选) * @author 简爱<sc.419@qq.com> * @since 1.0 */ class Test { /** * 函数的含义说明 * * @access public * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @param mixed $mixed 这是一个混合类型 * @since 1.0 * @return array */ public function Func($string, $integer, $mixed) { return array(); } }
程序代码注释
- 注释的原则是将问题解释清楚,并不是越多越好。
- 若干语句作为一个逻辑代码块,这个块的注释可以使用方式
- 具体到某一个语句的注释,可以使用行尾注释://
/* 生成配置文件、数据文件。*/ $this->init(); $this->add($data); // 添加数据 $this->delete($id); // 删除
本文出自简爱博客,转载时请注明出处及相应链接。
发表评论