什么是PHP注释文档标准

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

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


    Paste_Image.png

上干货

捡重要的写,其他的自己翻WIKI,或者自理
标记 用法 描述
@author 路漫漫 不解释
@copyright ©2016 网站底部随便就能看到
@link ahmerry@qq.com 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要你何用

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

<?php
namespace Base;
/**
 * 变量输出
 * 视图引入
 * @author 路漫漫
 * @link ahmerry@qq.com
 * @version V1.0
 * @since
 * <pre>
 * v0.9 2016/12/8 15:15  初版
 * v1.0 2016/12/12 14:21  增加默认视图
 * <pre>
 */
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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,468评论 5 473
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,620评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,427评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,160评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,197评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,334评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,775评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,444评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,628评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,459评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,508评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,210评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,767评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,850评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,076评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,627评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,196评论 2 341

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,319评论 25 707
  • 原文链接 必备品 文档:Documentation API:API Reference 视频:Laracasts ...
    layjoy阅读 8,599评论 0 121
  • Composer Repositories Composer源 Firegento - Magento模块Comp...
    零一间阅读 3,956评论 1 66
  • 女儿你真棒!看动画有感悟,也能发表出深刻的见解(爱表扬真的要及时记录,因为当时女儿在身边没有及时记录,女儿发表的深...
    持续一致的小东风阅读 204评论 2 4
  • 最近几年都在五台山风景名胜区总体规划,为什么说最近几年,因为这个项目从2015年启动,先是猛熬4个月,之后陆陆续...
    呼呼海爸阅读 560评论 0 2