美文网首页
什么是PHP注释文档标准

什么是PHP注释文档标准

作者: 路漫漫在狂奔 | 来源:发表于2016-12-12 22:40 被阅读95次

用过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

相关文章

  • 什么是PHP注释文档标准

    用过TP,用过CI,用过Laravel,CMS更是用到吐。总感觉这里不爽,那里不好(嗯,总有人扯淡说的通读xx框架...

  • 如何写出标准的,优雅的php注释(工程师篇)

    随着项目越来越复杂,项目不仅仅是代码的集合.文档与注释成了项目不可或缺的部分这边文档将说明如何写出标准的的php注...

  • PHPDoc PHP注释的标准文档(翻译自Wiki)

    文档注释,无非“//”和“/**/”两种 ,自己写代码,就那么点,适当写几句就好了;但是一个人总有融入团队的一天,...

  • Java基础之单行、多行、文档注释

    单行 //我是单行注释 多行 /* 我是多行注释 */ 文档注释 /** 我是文档注释 */ 文档注释和单行、多行...

  • 阅读

    阅读 Laravel 5.5 官方文档; Laravel 5.5 API 文档; PSR 通过的标准; PHP 最...

  • JAVA一些个基本问答

    【1】什么是注释?注释分为几种?注释有什么作用? 注释:用于解释说明程序的文字 注释分为:单行注释、多行注释、文档...

  • PHPExcel

    PHPExcel 是用来操作Office Excel 文档的一个PHP类库,它基于微软的OpenXML标准和PHP...

  • Java javadoc 标准和注释规范

    文档说明 1、文档概述:主要是描述Java javadoc 标准以及注释规范2、参考地址:https://blog...

  • Web开发快速入门基础篇(3)PHP基础

    3.PHP基础 基本语法 php文件结尾后缀为.php内容如下 注释//注释,当前行注释/***多行注释**/ 这...

  • Java入门初级中级问题及解答

    1:什么是注释?注释分为几种?注释有什么作用? 注释就是对代码的解释说明性文字,分为三种:单行注释、多行注释、文档...

网友评论

      本文标题:什么是PHP注释文档标准

      本文链接:https://www.haomeiwen.com/subject/leqvmttx.html