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

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 类注释..., 是因为个人不是常用, 当然还有一些注释没有总结到, 后面用到了再总结.

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

    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

    2.4K10

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

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

    66520

    【Python】Python 注释 ( 单行注释 | 多行注释 | 代码示例 )

    文章目录 一、Python 注释 1、单行注释 2、多行注释 3、代码示例 单行注释 : # 单行注释 多行注释 : """ 多行注释 多行注释 多行注释 """ 一、Python 注释 ---- Python...注释 可以 对 代码 进行解释说明 , 代码中的 注释 不会被执行 , 可以 增加代码的可读性 ; 1、单行注释 单行注释 : Python 中的 单行注释 以 # 开头 , # 右边是注释内容 ;...单行注释 中 , # 与 注释内容 建议使用 空格隔开 , 这是 Python 官方的建议 , 建议大家都遵守该规范 ; 单行注释 可以 独立占一行 , 也可以 写在代码右侧 ; 在 C / C++ /...之间添加空格 , 警告信息消失 ; 代码示例 : 下面的代码中 , 第一行中的 单行注释 独占一行 , 第二行中的 单行注释 在代码的右侧 ; # 单行注释 print(123) #...单行注释 2、多行注释 Python 多行注释 使用三个双引号 引起来 ; 三个双引号 即可以进行单行注释 , 又可以多行注释 , 代码如下 : """ 多行注释 """ """ 多行注释

    4.8K40

    Shell单行注释与多行注释

    1.单行注释 众所周知,Shell中使用 # 进行单行注释。...#-------------------------------------------- # 这是一个注释 # author:dablelv # company:tencent #----------...---------------------------------- 2.多行注释 在开发过程中,遇到大段的代码需要注释时,使用 # 注释每一行显得效率低下,可以使用如下方式,进行多行注释。...#或者 :<<0 语句1 语句2 0 (2)方法二 if false;then 语句1 语句2 fi (3)方法三 只需要将第一个条件置为false,那么后面的大括号的内容将不会被执行,达到了多行注释的效果...3.小结 Shell多行注释方法多样,本文仅列出部分可用方法,仅供参考。其它可用方法,不再一一推导列举,大家可举一反三。

    6.7K20

    Java魔法堂:注释注释模板

    一、注释                                     1. 注释类型      [a]....单行注释 // 单行注释 String type = "单行注释";      [b]. 多行注释 /* * 多行注释 */ String type = "多行注释";      [c]....文档注释 /** * 文档注释 */ public class Dummy{}   2. 快捷键      [a]. 添加/取消单行注释: Ctrl+/      [b]....添加类的文档注释: Ctrl+Shift+j 二、注释模板                                 作用:定义文件、类和方法等默认的注释格式,减少手工输入的工作量。...导入、导出注释模板     在 Window->Preference->Java->Code Style->Code Template 下可导入导出注释模板。

    2.6K60
    领券