什么是PHP注释文档标准

用过TP,用过CI,用过Laravel,CMS更是用到吐。总感觉这里不爽,那里不好(嗯,总有人扯淡说的通读xx框架的源码,就怎么怎么,在这里我向每一个通读了Laravel框架的神人两个字:**)
在PHP世界里,从来没有强烈需要一款大而全的框架!真的到了需要时,PHP只有辅助的份了。
感觉怨念有点深了,最近自己写PHP框架,渐渐开始重视注释的标准性,注释标准的好处是显而易见的

  • 可以自动的生成文档,最直接收益
  • 加快代码阅读
  • 团队交流
  • 什么?你是solo?那也可以写给自己,写给编辑器看嘛,不信?


    什么是PHP注释文档标准_第1张图片
    Paste_Image.png

上干货

捡重要的写,其他的自己翻WIKI,或者自理
标记 用法 描述
@author 路漫漫 不解释
@copyright ©2016 网站底部随便就能看到
@link [email protected] url,mail能找到你就好
@version 1.0:修改xxxx 有了git,要你何用
@since 2016.12.12 22:01:修改xxxx? 跟version傻傻分不清
@param int numbers 人数 用到的参数解释
@return array arr 返回的变量
@var string text 有parma要你何用

代码展示,请允许我秀一把


 * v0.9 2016/12/8 15:15  初版
 * v1.0 2016/12/12 14:21  增加默认视图
 * 
 */
class C {
    protected $m = null;
    public $method = null;
    protected $data = [];
    /**
     * 输出数组格式变量到视图
     * @param $key 输出到视图的变量名
     * @param $value 输出到视图的变量
     */
    public function assign($key , $value) {
        $this->data[$key] = $value;
    }
    /** 
     * @param $template 视图文件名,若为空则为方法名
     */
    public function display($template) {
        //检查数据
        extract($this->data);
        if (!$template){
            $template = $this->method;
        }
        //引入视图
        include (V_PATH. $template . '.php');
    }
}

标准参考自wiki

你可能感兴趣的:(什么是PHP注释文档标准)