PHP 代码规范(一点一点更新中...)

2021-05-05 11:29

阅读:751

标签:错误   情况   常量   row   邮箱   www   pen   event   图片   

  1. 代码注释,在写函数,类等用到。原文:https://www.jianshu.com/p/2011cc07f314
    技术图片技术图片
     1 /**
     2 * @name 名字
     3 * @abstract 申明变量/类/方法
     4 * @access 指明这个变量、类、函数/方法的存取权限
     5 * @author 函数作者的名字和邮箱地址
     6 
     7 * @category 组织packages
     8 * @copyright 指明版权信息
     9 * @const 指明常量
    10 * @deprecate 指明不推荐或者是废弃的信息
    11 * @example 示例
    12 * @exclude 指明当前的注释将不进行分析,不出现在文挡中
    13 * @final 指明这是一个最终的类、方法、属性,禁止派生、修改。
    14 * @global 指明在此函数中引用的全局变量
    15 * @include 指明包含的文件的信息
    16 * @link 定义在线连接
    17 * @module 定义归属的模块信息
    18 * @modulegroup 定义归属的模块组
    19 * @package 定义归属的包的信息
    20 * @param 定义函数或者方法的参数信息
    21 * @return 定义函数或者方法的返回信息
    22 * @see 定义需要参考的函数、变量,并加入相应的超级连接。
    23 * @since 指明该api函数或者方法是从哪个版本开始引入的
    24 * @static 指明变量、类、函数是静态的。
    25 * @throws 指明此函数可能抛出的错误异常,极其发生的情况
    26 * @todo 指明应该改进或没有实现的地方
    27 * @var 定义说明变量/属性。
    28 * @version 定义版本信息
    29 */
    View Code

     

  2. clean  code PHP github地址:https://github.com/php-cpm/clean-code-php#%E7%9B%AE%E5%BD%95

PHP 代码规范(一点一点更新中...)

标签:错误   情况   常量   row   邮箱   www   pen   event   图片   

原文地址:https://www.cnblogs.com/bneglect/p/12109050.html


评论


亲,登录后才可以留言!