首页 > 编程语言 >PHP类和方法注释规范:

PHP类和方法注释规范:

时间:2023-06-02 09:22:23浏览次数:44  
标签:函数 规范 信息 注释 指明 PHP 方法 变量 定义

/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息
* @example 示例
* @exclude 指明当前的注释将不进行分析,不出现在文挡中
* @final 指明这是一个最终的类、方法、属性,禁止派生、修改。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量,并加入相应的超级连接。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性。
* @version 定义版本信息
*/

标签:函数,规范,信息,注释,指明,PHP,方法,变量,定义
From: https://www.cnblogs.com/css2020/p/17450837.html

相关文章

  • Php中filter举例
    以下是一个使用PHPfilter的示例代码:$email="example.com";if(!filter_var($email,FILTER_VALIDATE_EMAIL)){echo("$emailisnotavalidemailaddress");}在此示例中,我们使用了PHP中的filter_var函数来验证一个电子邮件地址是否有效。如果电子邮件地址无效,将输出一......
  • php数组排序原理
    以下是一个使用PHP中的sort函数对数组进行排序的示例代码:$fruits=array("apple","banana","orange");sort($fruits);print_r($fruits);在此示例中,我们使用sort函数对$fruits数组进行升序排序。结果输出为["apple","banana","orange"]。PHP中的数组排序函数通常使用......
  • php找出重复文件
    以下是一个使用PHP在文件系统中查找重复文件的示例代码:$files=glob('/path/to/files/*');$hashes=array();foreach($filesas$file){if(is_file($file)){$hash=md5_file($file);if(isset($hashes[$hash])){echo"Duplicatefile:".$file......
  • php正则取值
    以下是一个使用PHP正则表达式获取值的示例代码:$string="Thisisasamplestringcontainingthevalue123.";$pattern='/\d+/';preg_match($pattern,$string,$matches);$value=$matches[0];echo"Thevalueis:".$value;在此示例中,我们使用preg_match函......
  • DWG文件的设计规范 V4.5.1(中英对照版)
    DWG文件的设计规范V4.5.1OpenDesignSpecificationfor.dwgfilesVersion5.4.1liability英[ˌlaɪəˈbɪləti] 美[ˌlaɪəˈbɪləti]n.责任;倾向;债务;妨碍assumesv.取得(权力)(assume的第三人称单数);假设;假定;呈现issubjectto英[izˈsʌbdʒikttu:] 美[ɪzˈs......
  • php 环境(直接在微软下载即可包含所有的)
    1.下载phpwindow64位 Windowsdownloads 2.下载iss7.0https://www.microsoft.com/web/downloads/platform.aspx这个网址时好时坏,要有耐心。下载的这个是一个平台,里面可以找到iishttp://php.net/manual/en/install.windows.legacy.index.php#install.windows.leg......
  • 文档注释
    基础注释@param{number}[duration]'[]'表示可选/***函数防抖*@listens*@param{function}func目标函数*@param{number}[duration]延迟执行的时间【[]表示可选】*@return{function}防抖的函数*/functiondobounce(func,duration=100){}......
  • Nginx配置隐藏模块后的.php后缀
    要在Nginx中配置隐藏框架模块后的.php后缀,并将URL重写为http://example.com/index/user/profile,请按照以下步骤进行操作:1.  打开Nginx配置文件。2.  添加以下配置,启用URL重写和模块隐藏:server{listen80;server_nameexample.com;root/pat......
  • python代码规范 自动优化工具Black
    自动优化工具Black在众多代码格式化工具中,Black算是比较新的一个,它***的特点是可配置项比较少,个人认为这对于新手来说是件好事,因为我们不必过多考虑如何设置Black,让Black自己做决定就好。1).安装与使用与pylint类似,直接pipinstallblack即可完成该模块的安装,不过black依赖于Pyth......
  • 最规范的汇编函数传参demo
    assumecs:code;记忆点:1.主函数,子函数都需要自己维护bp和sp(当然不维护也行,但是非常容易出bug,所以还是要强烈按照下面子函数头,子函数尾.主函数头尾这么写,最安全.)2.函数ip都有压栈出站自动维护但是自己要算明白栈的偏移量.codesegmentraddprocpus......