php

位置:IT落伍者 >> php >> 浏览文章

php的注释规范


发布日期:2023年05月11日
 
php的注释规范

@access

使用范围classfunctionvardefinemodule

该标记用于指明关键字的存取权限privatepublic或proteced

@author

指明作者

@copyright

使用范围classfunctionvardefinemoduleuse

指明版权信息

@deprecated

使用范围classfunctionvardefinemoduleconstentglobalinclude

指明不用或者废弃的关键字

@example

该标记用于解析一段文件内容并将他们高亮显示Phpdoc会试图从该标记给的文件路径中读取文件内容

@const

使用范围define

用来指明php中define的常量

@final

使用范围classfunctionvar

指明关键字是一个最终的类方法属性禁止派生修改

@filesource

和example类似只不过该标记将直接读取当前解析的php文件的内容并显示

@global

指明在此函数中引用的全局变量

@ingore

用于在文档中忽略指定的关键字

@license

相当于html标签中的<a>首先是URL接着是要显示的内容

例如<a href=”百度</a>

@link

类似于license

但还可以通过link指到文档中的任何一个关键字

@name

为关键字指定一个别名

@package

使用范围页面级别的> definefunctioninclude

类级别的>classvarmethods

用于逻辑上将一个或几个关键字分到一组

@abstrcut

说明当前类是一个抽象类

@param

指明一个函数的参数

@return

指明一个方法或函数的返回指

@static

指明关建字是静态的

@var

指明变量类型

@version

指明版本信息

@todo

指明应该改进或没有实现的地方

@throws

指明此函数可能抛出的错误异常极其发生的情况

上面提到过普通的文档标记标记必须在每行的开头以@标记除此之外还有一种标记叫做inline tag用{@}表示具体包括以下几种

{@link}

用法同@link

{@source}

显示一段函数或方法的内容

上一篇:PHP生成雪花背景的网站验证码

下一篇:PHP 外部获取函数参数个数