php定名、注释规范

/** * 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 * @since          1.0 */  class Test   {  }  

4.程序代码注释

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

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

3）. 具体到某一@本文来源gaodaimacom搞#代%码@网-搞代gaodaima码个语句的注释，可以使用行尾注释：//。

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

二、命名规范

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

---

搞代码网（gaodaima.com）提供的所有资源部分来自互联网，如果有侵犯您的版权或其他权益，请说明详细缘由并提供版权或权益证明然后发送到邮箱[email protected]‍，我们会在看到邮件的第一时间内为您处理，或直接联系QQ：872152909。本网站采用BY-NC-SA协议进行授权
转载请注明原文链接：php定名、注释规范

喜欢 (0)赏

[搞代码]

分享 (0)