首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

PHP注释标记整理

什么是注释标记 我们在平常写代码或看别人写的代码时, 在方法的说明注释中经常会有这样的注释: /** * @param $num * @return array */ 上面的@param @return...就是注释标记 注释标记用于生成文档, param指明需要接收的参数, return指明返回值 在使用 phpDocumentor 等工具生成文档时, 会识别相关注释, 而且IDE也会识别, 在编码的过程中会给出提示...PHP注释标记总结 @api: 提供给第三方使用的接口 @author: 标明作者 @param: 参数 @return: 返回值 @todo: 待办 @version: 版本号 @inheritdoc...: 文档继承 @property: 类属性 @property-read: 只读属性 @property-write: 只写属性 @const: 常量 @deprecated: 过期方法 @example..., 且子类出现冲突文档时重写父类文档 @internal 标识此类或方法仅限当前文件使用 @description [描述] @link 指明外部链接, 必须给出完整url @link [url] [描述

2K20

JSDoc 初探:代码内的文档标记

JSDoc 3 是一个用于 JavaScript 的API文档生成器,类似于 Javadoc 或 phpDocumentor。可以将文档注释直接添加到源代码中。...JSDoc是一种用于为JavaScript代码生成文档的工具。它基于标签(tag)的形式,通过注释来提取代码中的类型、描述、参数、返回值等信息,生成文档供其他人参考。...使用=标记具有默认值的参数or可选参数在JSDoc中,可以使用 = 符号来标记具有默认值的参数。具体来说,在 @param 标签后面添加一个参数名和默认值,用 = 符号连接即可。...需要注意的是,在JSDoc中标记参数具有默认值并不会改变函数或方法的实际调用方式,你可以只在注释中写好标记的默认参数,而不写在代码中,反之亦然(君子协定)。...,但是不能标记默认值。

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

    pytest文档16-标记失败xfail

    前言 当用例a失败的时候,如果用例b和用例c都是依赖于第一个用例的结果,那可以直接跳过用例b和c的测试,直接给他标记失败xfail 用到的场景,登录是第一个用例,登录之后的操作b是第二个用例,登录之后操作...如果登录都失败了,那后面2个用例就没测试必要了,直接跳过,并且标记为失败用例,这样可以节省用例时间。 用例设计 1.pytest里面用xfail标记用例为失败的用例,可以直接跳过。...test_03全部调用fixture里面的login功能 test_01测试登录用例 test_02和test_03执行前用if判断登录的结果,登录失败就执行,pytest.xfail(“登录不成功, 标记为...login print("用例3,登录结果:%s" % result) if not result: pytest.xfail("登录不成功, 标记为...login print("用例3,登录结果:%s" %result) if not result: pytest.xfail("登录不成功, 标记

    1.2K30

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

    Phpdoc会试图从该标记给的文件路径中读取文件内容 @const 使用范围:define 用来指明php中define的常量 @final 使用范围:class,function,var 指明关键字是一个最终的类...@filesource 和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。...@var 指明变量类型 @version 指明版本信息 @todo 指明应该改进或没有实现的地方 @throws 指明此函数可能抛出的错误异常,极其发生的情况 普通的文档标记标记必须在每行的开头以@标记...,只保留一个即可 f.调用了其他函数或类的地方,要使用link或其他标记链接到相应的部分,便于文档的阅读。...g.必要的地方使用非文档性注释,提高代码易读性。 h.描述性内容尽量简明扼要,尽可能使用短语而非句子。 i.全局变量,静态变量和常量必须用相应标记说明 示例 <?

    1.2K21

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

    PHP中针对区域语言标记信息的操作 相信大家对 zh_CN 这个东西绝对不会陌生,不管是 PHP 中,还是在我们的网页上,都会见到它的身影。...对于这种区域语言的标记来说,PHP 中也有很多好玩的内容。今天,我们要学习的 Locale 类就是操作区域语言相关内容的,它无法被实例化,所有全部功能方法都是静态的。..."Matches" : "Does not match", PHP_EOL; 当然,我们也可以使用另一个 lookup() 方法来确定给定的一系列语言标记哪个与指定的标记最接近。...测试代码: https://github.com/zhangyue0503/dev-blog/blob/master/php/202011/source/5.PHP中针对区域语言标记信息的操作.php...参考文档: https://www.php.net/manual/zh/class.locale.php https://www.zhihu.com/question/20797118/answer/63480740

    1.3K40

    HTML布局标记和列表标记

    布局标记 首先要介绍的布局标记是div标记,div可以做网页的层也可以做网页的分区。当div做网页的层时可以实现漂浮在网页上的效果,就像我们经常可以在网站里看见的那些漂浮广告。...我们查看一下百度搜索的源码就可以看到,这个页面用的最多的标记就是div,所以也就可以知道这个页面是使用div标签来布局的: ?...table标记和div标记一样都是属于网页布局的标记,table主要是用来做表格,table里常用的属性是:border表格的边界线、cellpadding 表格的填充程度、cellspacing 内间距距离...列表标记 首先要介绍的第一个列表是ul无序列表,无序列表是一个项目的列表,此列项目使用粗体圆点(典型的小黑圆圈)进行标记,ul需要嵌套li实现列表效果。...接下来是ol有序列表同样,有序列表也是一列项目,列表项目使用自增的数字进行标记,所以称为有序列表。有序列表始于 标签,每个列表项也是始于 标签,代码示例: ? 运行结果: ?

    4.2K20

    标记字段

    标记字段 代码中有时候有这种需求:需要一个公共访问的标记字段,以下称为标记字段。...从需求上看,不是当前对象设置的标记它就不应该去清除,因为另一个对象在重新设置标记字段的值得时候自动清除了上一标记值。...可以使用一个额外的字段记录对标记进行赋值的对象,然后通过比较当前对象标记试图操作的对象和之前设置已有标记值的对象就可以得到需要的标记作用。...下面设计一个类型FlagField来组合标记值和标记人,使得标记字段的含义更加内聚。 FlagField类型 代码如下: /** * 标记字段,用来存储被公共访问的带有赋值者信息的数据。...赋值者在合适的时间赋值, * 之后可以清除标记值,如果中间有其它 * 赋值者重新标记则清除操作不做任何动作——访问者继续 访问新的标记

    1.6K90
    领券