首页
学习
活动
专区
圈层
工具
发布

PHP注释标记整理

什么是注释标记 我们在平常写代码或看别人写的代码时, 在方法的说明注释中经常会有这样的注释: /** * @param $num * @return array */ 上面的@param @return...就是注释标记 注释标记用于生成文档, param指明需要接收的参数, return指明返回值 在使用 phpDocumentor 等工具生成文档时, 会识别相关注释, 而且IDE也会识别, 在编码的过程中会给出提示...PHP注释标记总结 @api: 提供给第三方使用的接口 @author: 标明作者 @param: 参数 @return: 返回值 @todo: 待办 @version: 版本号 @inheritdoc...void: 无 null: callable: 回调函数 function: 方法 self/$this: 当前实例 @throws 抛出异常 @throws [类型] [描述] @method 类注释...有一些注释没有给出说明, 是因为个人不是常用, 当然还有一些注释没有总结到, 后面用到了再总结.

2.8K20

01_PHP基础——PHP标记与注释

PHP语法初步 PHP是一种运行在服务器端的脚本语言,可以嵌入到HTML中。...PHP代码标记 在PHP历史发展中,可以使用多种标记来区分PHP脚本 ASP标记:php代码 %> 短标记:Php代码 ?...>,以上两种基本弃用,如果要使用那么需要在配置文件中开启 脚本标记:php”>php代码 标准标记(常用):php php代码?...> PHP注释 习惯:所有的代码在写的过程中都必须进行注释,对于初学者而言,注释就是个人学习和写代码的一个思路说明 PHP中注释分为两种:行注释和块注释 行注释:一次注释一行 //:后面跟的所有内容都是注释...#:与//一样 块注释:一次注释多行 /:中间直到/出现之前,全部都是注释 */

1.1K30
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    PHP系列 | PHP Document 注释标记及规范 && PHP命名规范

    注释标记 @access 使用范围:class,function,var,define,module 该标记用于指明关键字的存取权限:private、public或proteced @author 指明作者...Phpdoc会试图从该标记给的文件路径中读取文件内容 @const 使用范围:define 用来指明php中define的常量 @final 使用范围:class,function,var 指明关键字是一个最终的类...@filesource 和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。...,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种: {@link} 用法同@link {@source} 显示一段函数或方法的内容 注释规范 a.注释必须是 /** *...注释内容 */ 的形式 b.对于引用了全局变量的函数,必须使用glboal标记。

    1.8K21

    代码注释中的常见标记

    FIXME 在代码注释中,FIXME 是一个常见的标记,用来指出代码中的一个问题需要被修复或需进一步的工作。...使用 FIXME 注释的原因可能包括: 代码存在已知的错误,但需要更多的调查或复杂的修复。 功能实现了,但可能不够稳健或有效,需要进一步的优化。...FIXME 类似于其他代码注释标记,如 TODO (表示还有工作要做)或 NOTE(用来强调或解释代码的某个方面),但 FIXME 更具有紧迫性,通常表示代码中存在更严重的问题或错误。...开发团队可能会有自己的注释标记约定,实际使用的标记取决于团队的偏好和工作流程。使用这些标记可以帮助团队成员快速定位代码中需要特别注意的部分。...在一些集成开发环境(IDE)或文本编辑器中,这些标记可能会被特殊显示,以便开发者能够更容易地发现和跟踪这些注释。

    1.7K10

    属性元素,标记扩展和注释

    这节来讲一下XAML中的属性元素,标记扩展,和注释。...标记扩展 标记扩展是xmal最特色的一个东西,它同样是给属性赋值的一种形式,但是标记扩展正如它的名字一样,是对属性赋值的扩展,它是我们后续要讲的MVVM模式中控件和数据的桥梁。...当我们改变VM属性值时,前台的控件值就会变,这就是WPF与众不同的地方:数据驱动控件。初学者,可以先做了解,后续我们会持续接触标记扩展,而且也只有在代码中才能更好的理解标记扩展的强大。...注释 最后讲一下xaml中的注释。 使用注释内容 --> 来注释一段xaml代码,但是需要注意一下几点: 1.注释只能出现在开始标签和结束标签之间,也就是只能出现在内容区域 2.不能注释标签的属性 3.不能嵌套使用注释

    1.2K10

    PHP过滤html注释

    过滤html注释: 所谓过滤,不过是字符串的匹配与替换,这里我们用到的正则匹配替换函数preg_replace(reg,replace,string);,PHPer都清楚,这个函数的关键在于reg的精确度...,那么我们就来试试看吧: 首先要知道html注释的格式,是这样的:。...\/\/)-->/","",$html); 这样的话我基本上就去掉了我需要去掉的html的注释了!...意外收获:在优化过程中,没有对多行注释进行考虑,但规则意外的正常匹配了多行注释,不知道是否因为是从文件读取的html! 经测试尚未发现有将正文过滤掉的情况,如有疑问,欢迎留言指正。...本文采用 「CC BY-NC-SA 4.0」创作共享协议,转载请标注以下信息: 原文出处:Yiiven https://www.yiiven.cn/php-filter-html.html

    3.6K10

    PHP中针对区域语言标记信息的操作

    PHP中针对区域语言标记信息的操作 相信大家对 zh_CN 这个东西绝对不会陌生,不管是 PHP 中,还是在我们的网页上,都会见到它的身影。...其实这就是指定我们的显示编码是什么国家或者地区的,使用何种语言。对于这种区域语言的标记来说,PHP 中也有很多好玩的内容。...关于语言标记的规则 在继续学习下面的内容之前,我们先来学习一下语言标记的规范。..."Matches" : "Does not match", PHP_EOL; 当然,我们也可以使用另一个 lookup() 方法来确定给定的一系列语言标记哪个与指定的标记最接近。...测试代码: https://github.com/zhangyue0503/dev-blog/blob/master/php/202011/source/5.PHP中针对区域语言标记信息的操作.php

    2.3K40

    如何优雅地写好易读的、标准的Php注释

    某不知名老鸟曾经说过,写代码时,代码注释是非常必要的,只是几段灰色字符串却能瞬间提升代码可读性、可重构性。...我个人也认为学习 Php 的初期便需要习惯和熟练使用代码注释,才不至于多年之后久别重温自己的杰作却感叹“我™都谢了写啥 bug?!”...,那么下面便是一些常用的 php 注释规范,也当是给自己做个备份:) @access 使用范围:class,function,var,define,module 该标记用于指明关键字的存取权限:private...Phpdoc会试图从该标记给的文件路径中读取文件内容 @const 使用范围:define 用来指明php中define的常量 @final 使用范围:class,function,var...@filesource 和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。

    99820

    CellSTAR——单细胞转录组亚群标记基因注释数据库

    如果是肿瘤领域的可以是如下所示的分类: immune (CD45+,PTPRC), epithelial/cancer (EpCAM+,EPCAM), stromal (CD10+,MME,fibro...or CD31+,PECAM1,endo) 参考我五年前介绍过的 CNS图表复现08—肿瘤单细胞数据第一次分群通用规则,这3大单细胞亚群构成了肿瘤免疫微环境的复杂。...而且我们已经积累了心肝脾肺肾等多个器官的上皮细胞的细分亚群, 以及免疫细胞里面的髓系和B细胞细分亚群: B细胞细分亚群 髓系免疫细胞细分亚群 但是这样的人工手动对单细胞亚群进行检测一系列已知的基因的表达量的方式...而且每个人的背景知识是不完善的,所以就衍生出来了一系列相关网页工具和知识库。今天我们要介绍的就是CellSTAR——单细胞转录组亚群标记基因注释数据库!...这些数据来自不同的项目和测序技术,包含了18个物种和139种组织。 cell marker是识别和分类细胞类型的关键因素。

    80410

    单细胞测序—标准流程代码(2) — 标记基因与细胞注释

    单细胞测序—标准流程代码(2) — 标记基因与细胞注释书接上回,已经做好数据质控、过滤、去批次、降维聚类分群后,接下来就是进行细胞注释方面的工作step4: 看标记基因库# 原则上分辨率是需要自己肉眼判断...Bcels_markers_list(B细胞标记基因列表):这个列表包含了与B细胞相关的标记基因,B细胞是免疫系统中产生抗体的细胞。...操作除非0.1确实分群太粗狂了,我们就选择0.8根据上述图片手动给细胞分群命名这里因为用的是测试数据集,其自带细胞注释。...因此用气泡图比较了本身和手动注释的区别。...这里手动注释还是比较粗糙的,为了方便显示,还是使用数据集本身自带的细胞注释进行后续的分析#DimPlot(sce.all.int, reduction = "umap",raster = F,group.by

    2.2K11

    php对象字段声明,easyswoole ORM 快速生成注释

    ide提示 在PHPSTORM IDE中,我们可以通过注释给类写明可调用字段名,这样子才有语法提示。 比如在Thinkphp中,虽然允许我们可以通过对象属性方式去调用,但是并没有语法提示。...添加注释后 就舒服很多了。...测试字段名 */ class RefundDetail extends Mode { } 使用 $class = new RefundDetail(); $class->test 当我们输入一部分的时候...,IDE就会提示我们语法啦~直接选中就可以了 easyswoole 在easyswoole中也是一样的,我们可以快速给类生成注释来达到语法提示 我写了一个小工具,可以通过SQL create table...我的博客即将同步至腾讯云+社区,邀请大家一同入驻:https://cloud.tencent.com/developer/support-plan?invite_code=8vto1mh8z7c8

    1.4K30

    JVM 彻底搞懂几种常见的垃圾回收机制|标记清除|标记复制|标记整理

    在jvm中有些对象是用完就不需要的(业务对象),有些对象则是长久存留的(如Spring的一些组件),所以我们不可能按照同样的收集方式去处理这些对象,所以jvm就会把这些对象进行区分,将存活不久的对象放在新生代...标记复制 标记复制算法会将内存空间一分为二,每次只会使用一半,另外一半用来保存下次存活的对象。在进行收集时,它会将存活对象全部复制到另外一半的内存空间,然后再把零碎的垃圾对象全部回收。...为什么标记复制一般用在年轻代? 因为标记复制 复制的是存活对象,存活对象越多,那么复制的效率就越低,但是年轻代存活对象一般比较少,所以非常适合使用标记复制算法。...回收前 回收后 标记清除 分为两个步骤:标记和清除,清除的是垃圾,标记的可以是垃圾也可以是存活对象,要看具体垃圾回收算法实现。...回收前 回收后 存在的问题 会产生空间碎片 标记压缩(整理) 标记压缩是在标记清除后,进行了一次碎片整理的操作,使得碎片空间小时,对象存放在连续的空间中。

    2K40
    领券