php的注释标记是什么意思,PHPer都应当掌握的注释标记！
发布时间：2022-12-09 10:49:38 所属栏目：PHP教程 来源：
导读： @deprecatedversion文档中被废除的方法
@deprec同 @deprecated
@example/path/to/example文档的外部保存的示例文件的位置。
@exception文档中方法抛出的异常，也可参照 @throws.
@deprec同 @deprecated
@example/path/to/example文档的外部保存的示例文件的位置。
@exception文档中方法抛出的异常，也可参照 @throws.
|
@deprecatedversion文档中被废除的方法 @deprec同 @deprecated @example/path/to/example文档的外部保存的示例文件的位置。 @exception文档中方法抛出的异常，也可参照 @throws. @global类型：$globalvarname文档中的全局变量及有关的方法和函数 @ignore忽略文档中指定的关键字 @internal开发团队内部信息 @linkURL类似于license 但还可以通过link找到文档中的更多个详细的信息 @name变量别名为某个变量指定别名 @magicphpdoc.de compatibility @package封装包的名称一组相关类、函数封装的包名称 @param如 $username 用户名变量含义注释 @return如 返回bool函数返回结果描述，一般不用在void(空返回结果的)的函数中 @see如 Class Login()文件关联的任何元素(全局变量，包括，页面，类php注释，函数，定义，方法，变量)。 @sinceversion记录什么时候对文档的哪些部分进行了更改 @static记录静态类、方法 @staticvar在类、函数中使用的静态变量 @subpackage子版本 @throws某一方法抛出的异常 @todo表示文件未完成或者要完善的地方 @vartype文档中的变量及其类型 @version文档、类、函数的版本信息 上面这么多其实很大一部分都是创建文件、创建类的时候需要添加的。今天主要讲解一下常用的标签。 @param 说明 参数，用于函数和方法注释里的标记\ 格式@param [Type] [name] []\ 例如@param string title 文章标题 代码举例 @return 说明 返回值 格式@return [类型] []] 例如@return array 结果数组 代码举例 @deprecated 说明 不建议使用的、已过期的、将被删除的\ 格式@deprecated [] []\ 例如@deprecated 1.0.0 新版本将不再包含此函数\ 如果它是被其他方法所取代了，建议添加@see标记 代码举例 @see 说明 参考，类似@link，可与@deprecated联动 格式@see [url或完整方法名] [] 例如@see \yii\base\db::tableName() 旧方法table_name已弃用，请使用此方法替代 代码举例 @link 说明 链接，可用于辅助说明、引用文档等\ 格式@link [url] []\ 例如@link 不懂滚去问谷歌，别来烦我 代码举例 @link&@see区别-@see@link外部链接√√ 内部程序√X @var 说明 变量\ 格式@var [类型] [变量名] []\ 例如@var int id 用户id 变量列表变量类型说明string字符串 integer/intnumber/int类型 boolean/boolfalse/true float/doublenumber/浮点数 object对象实例 specifiedType指定类 mixed任意类型 array/specifiedType[]数组，可以指定成指定类型的数组 resource文件资源类型 void无返回值 null- callable可执行的回调函数 function不一定能执行的方法 self/$this当前实例 代码举例 1、在方法外的变量定义 2、在方法内的变量定义 @throws 说明 可能会抛出的错误类型\ 格式@throws [类型] []\ 例如@throws Exception （编辑：我爱资讯网） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |
站长推荐