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

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
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    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

    c语言-注释

    “注释”是字符序列由编译器将一个空白字符和否则将忽略的一个正斜杠/星号组合 (/*) 开头。 注释可以包括任何字符组合可以从可用的字符集的,包括换行符,但是,排除 “结束注释”分隔符 (*)。...注释占用多个行,但不能嵌套。 注释可以显示任何位置空白字符授权。 因为编译器将注释作为一个空白字符,不能包括在标记中的注释。 编译器忽略在注释的字符。 使用文档注释代码。 ...注释可以出现在行和代码语句相同: printf( "Hello\n" ); /* Comments can go here */ 可以选择在函数或具有描述性注释的程序模块块: /* MATHERR.C...,当找到在注释时,的 */ 它尝试处理剩余的文本会产生错误。 可以使用注释仅为测试目的时使某些代码行非活动,预处理器指令 #if 和 #endif 和条件编译。此任务的有用的替代方法。...Microsoft 专用 Microsoft 编译器还支持两个正斜杠的单行注释 (//) 之后。 如果使用 /Za 编译。 (ANSI 标准),这些注释生成错误。 这些注释不能扩展到第二行。

    1.7K30

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

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

    1.1K30

    【C语言指南】注释

    注释只是为了提高可读性,不会被计算机编译。注释是对代码的说明,编译器会忽略注释,也就是说,注释对实际代码没有影响。...C语言注释有三种方式 ,分别是单行注释,多行注释和条件编译注释,其中前两种在初级编程较为常见 1.单行注释 C99标准引入的注释方式 将注释放在双斜杠 // 后面,从双斜杠到行尾都属于注释。...0; } 2.多行注释(块注释) 将注释放在 /*...*/ 之间,内部可以分多行。...int print(int arr, int sz/*数组元素*/,char a); /**/ 的这个注释不支持嵌套注释 /* 开始注释后,遇到第⼀个 */ 就认为注释结束了。...注释在双引号内失效 不管是哪⼀种注释,都不能放在双引号里面。

    1.2K10

    鸿蒙开发:ArkTs语言注释

    前言本篇文章节选于主要讲述ArkTs语言注释相关,所有案例均基于Api13。...所以,为了自身和他人能够无障碍的继续维护代码,建议,注释还是要添加的。ArkTs中为我们提供了两种注释方式,一种是单行注释,另一种是多行注释。...,以 /* 开始,以 */ 结尾,多行注释使用的地方也是非常的常见,像下面所阐述的方法和类注释等都是属于多行注释,当我们随便打开一个系统的源码,都会看到这样的注释。...,可以使用单行注释,也可以使用多行注释,多行注释,针对变量的说明更加清晰,更加细致,我们可以打开系统的Api,可以发现,系统大部分也都是基于多行注释。...小结关于注释,有一点需要注意,那就是,注释,不会被编译器或解释器执行,而本小节的重点并不是简单的教大家注释如何去写,而是在实际的项目中,我们能够真正的把注释投入到实际的开发中。

    51900

    几种语言的注释方法

    C/C++以及JAVA 行注释://注释内容 多行注释:/*注释内容*/ Python 行注释:#注释内容 多行注释:Python并没有提供多行注释的语法。...目前常用替代除了编辑器处理外,就是采用: '''注释内容'''或者"""注释内容""",其实三个引号代表的是多行字符串,之所以用来注释,是因为引号里的字符串不会作为命令执行,并且支持多行。...但是需要注意在一个类里这么注释时可能引起的缩进的错误,因为它毕竟不是规定的注释。 Bash 单行注释:#注释内容 多行注释:同Python一样,没有规定的注释语法。...:<<'EOF' 注释内容 EOF 3. :<<'EOF 注释内容 EOF' 4....:<<EOF' 注释内容 'EOF 5. :<<' 注释内容 ' 此段内容摘自:bash的多行注释 html 只有多行注释: 注释内容-->

    1.2K20

    C 语言注释和变量详解

    C 语言中的注释 C语言中可以使用注释来解释代码并使其更具可读性。它还可以在测试替代代码时防止执行。 单行注释 单行注释以两个斜杠 (//) 开头。...此示例在代码行之前使用单行注释: // 这是一个注释 printf("Hello World!"); 此示例在代码行的末尾使用单行注释: printf("Hello World!")...; 单行还是多行注释? 由您决定使用哪种。通常,我们使用 // 作为短注释,使用 /* */ 作为较长的注释。 需要注意的是:在 C99 版本(1999 年发布)之前,您只能在 C 中使用多行注释。...C 语言中的变量 变量是用于存储数据值(如数字和字符)的容器。...然而,这在 C 语言中是不可能的: int myNum = 15; printf(myNum); // 什么也不会发生 要在 C 语言中输出变量,您必须熟悉称为“格式说明符”的东西。

    95620

    各种编程语言的注释符

    常见语言: c 行注释:none 块注释: 扩展名:.c/.h c++ 行注释://这里是注释 块注释: 扩展名:.cpp/.h c# 行注释://这里是注释 块注释: xml注释:///这里是...xml注释 扩展名:.cs vb 行注释:'这里是注释 块注释:none 扩展名:.bas java 行注释://这里是注释 块注释: 扩展名:.java vb.net 行注释:'这里是注释 块注释...:none xml注释:///这里是xml注释 扩展名:.vb perl 行注释:#这里是注释 块注释:none 扩展名:.pm html 行注释:none 块注释:<!...# InlineComment =beginBlockComment=cut (POD documentation comment)__END__Comments after end of code PHP...# InlineComment// InlineComment /* BlockComment *//** Documentation BlockComment */ (PHP Doc comments

    3K40

    pycharm设置c语言注释颜色,pycharm设置注释颜色的方法

    pycharm设置注释颜色的方法 操作方法如下所示: File–>Settings–>Editor–>Color&Fonts–>LanguageDefaults–>Linecomment–>设置颜色即可...以上这篇pycharm设置注释颜色的方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持我们。...@contact: deamoncao 一.注释 1....#单行注释 2. “”” 多行注释 “”” 3. pycharm多行注释快捷键:Ctrl+/ 二.缩进 缩进:Tab 反向缩进:Shift+Tab 以上这篇在Pycharm中对代码进行注释和缩进的方法详解就是小编分享给大家的全部内容了...首先打开PyCharm,右上角文件点击,找到默认位置: 打开默认设置找到编辑器->编辑器: 找到code style -> python来设置代码的格式:python格式化代码,制表符和缩进,也 C语言中左移和右移运算符详细介绍

    4.2K20

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

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

    99820
    领券