php定名、注释规范-php教程-PHP中文网

php定名、注释规范

php中文网

发布： 2016-06-13 12:20:46

原创

1007人浏览过

php命名、注释规范

一、注释

1.文件头部模板

/** *这是一个什么文件 * *此文件程序用来做什么的（详细说明，可选。）。 * @author      richard<[email&#160;protected]> * @version     $Id$ * @since        1.0 */

登录后复制

2.函数头部注释

/** * some_func  * 函数的含义说明 * * @access public * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @param mixed $mixed 这是一个混合类型 * @since 1.0 * @return array */  public function thisIsFunction($string, $integer, $mixed) {return array();}

登录后复制

3.类的注释

/** * 类的介绍 * * 类的详细介绍（可选。）。 * @author         richard<[email&#160;protected]> * @since          1.0 */  class Test   {  }

登录后复制

4.程序代码注释

立即学习“PHP免费学习笔记（深入）”；

1）. 注释的原则是将问题解释清楚，并不是越多越好。

小邮包包月订购包年程序

小邮包-包月订购包年服务网，该程序由好买卖商城开发，程序采用PHP+MYSQL架设，程序商业模式为目前最为火爆的包月订制包年服务模式，这种包年订购在国外网站已经热火很多年了，并且已经发展到一定规模，像英国的男士用品网站BlackSocks，一年的袜子购买量更是达到了1000万双。功能：1、实现多产品上线，2、不用注册也可以直接下单购买，3、集成目前主流支付接口，4、下单发货均有邮件提醒。

查看详情

2）. 若干语句作为一个逻辑代码块，这个块的注释可以使用/* */方式。

3）. 具体到某一个语句的注释，可以使用行尾注释：//。

/* 生成配置文件、数据文件。*/    $this->setConfig();  $this->createConfigFile();  //创建配置文件  $this->clearCache();         // 清除缓存文件  $this->createDataFiles();   // 生成数据文件  $this->prepareProxys();  $this->restart();

登录后复制

二、命名规范

http://alloyteam.github.io/code-guide/#project-naming