• 代码注释


    1如何写PHP规范注释
    所有的文档标记都是在每一行的 * 后面以@开头。如果在一段话的中间出来@的标记,这个标记将会被当做普通内容而被忽略掉。
    @access 该标记用于指明关键字的存取权限:private、public或proteced 使用范围:class,function,var,define,module
    @author 指明作者
    @copyright 指明版权信息
    @const 使用范围:define 用来指明php中define的常量
    @final 使用范围:class,function,var 指明关键字是一个最终的类、方法、属性,禁止派生、修改。
    @global 指明在此函数中引用的全局变量
    @name 为关键字指定一个别名。
    @package 用于逻辑上将一个或几个关键字分到一组。
    @abstrcut 说明当前类是一个抽象类
    @param 指明一个函数的参数
    @return 指明一个方法或函数的返回值
    @static 指明关建字是静态的。
    @var 指明变量类型
    @version 指明版本信息
    @todo 指明应该改进或没有实现的地方
    @link 可以通过link指到文档中的任何一个关键字
    @ingore 用于在文档中忽略指定的关键字

    一些注释规范
    a.注释必须是
    /**
    * XXXXXXX
    */
    的形式;
    b.对于引用了全局变量的函数,必须使用glboal标记。
    c.对于变量,必须用var标记其类型(int,string,bool...)
    d.函数必须通过param和return标记指明其参数和返回值
    e.对于出现两次或两次以上的关键字,要通过ingore忽略掉多余的,只保留一个即可
    f.调用了其他函数或类的地方,要使用link或其他标记链接到相应的部分,便于文档的阅读。
    g.必要的地方使用非文档性注释(PHPDOC无法识别的关键字前的注释),提高代码易读性。
    h.描述性内容尽量简明扼要,尽可能使用短语而非句子。
    i.全局变量,静态变量和常量必须用相应标记说明

  • 相关阅读:
    List
    美团Leaf分布式ID生成策略
    单点登陆
    ElasticSearch
    Eureka
    Nginx
    UML
    Computer English
    加密
    Excel中把一列数据转换成逗号隔开的一行
  • 原文地址:https://www.cnblogs.com/lichihua/p/5706461.html
Copyright © 2020-2023  润新知