码迷,mamicode.com
首页 > Web开发 > 详细

常用的phpdoc标签

时间:2019-04-22 12:19:53      阅读:149      评论:0      收藏:0      [点我收藏+]

标签:技术   解决问题   如何使用   format   作用   生成   desc   指针   其它   

标签 说明

@access public|private|protected

描述了访问级别。当使用反射技术时,这个标签不是很有用,这是因为API能够自动获取这一特性。在PHPDoc中,用它可略去私有成员的文档生成。

@author Author Name [<author@email.com>]

帮助获得负责某个特定元素的人的信息(强烈推荐使用这一标签)

@copyright Copyright Information

可指定代码的版权所有者

@deprecated [version information]

可通知代码的使用者这个元素不再被使用并且已经被替换

@example [path|url] description

可引用一个例子,阐释如何使用这个元素。第二个参数可以是一个路径也可以是一个完整的URL

@filesource

可用来表示希望让文件源出现在文档中,这一标签只能出现在页面级别的块中,在其他地方出现将会被忽略

@global datatype description

说明了全局变量的数据类型。这一标签必须紧贴在全局变量的前面,并且只对PHPDocumentor解析器起作用。对于基于反射技术的解析器用处不大。

@ignore

通知解析器忽略这个元素,并且不将它包含在文档中

@internal

可以隐藏特定的信息,使之不出现在公开文档中。可以用在内嵌的注释内容中或者新行注释中。

@license url [license]

指定此软件授权信息的URL,还可以说明授权者的姓名

@link url [description]

在文章中包含一个连接。这个标签可以用在内嵌的内容中。

@param datatype $variablename [,...]

description

说明与函数和方法关联的参数。这可能是最重要的标签。变量名称参数可以包括,...符号以表示函数可以传入不定数量的其它参数
@return datatype description 说明了函数或方法返回的数据类型,这可能是第二个重要的标签,并且它是在PHP中包含关于返回数据的元数据的唯一方法。推荐所有具有返回值得函数使用这一标签。
@see reference 引用另外一个元素的文档。在这里可以使用不同类型的指针,包括文件、函数名称、类方法以及其他许多类型的指针。多个指针值可以用逗号隔开。这个标签也可以用在内嵌的内容中。

@since version [informatioin]

 用于说明这个元素第一次出现的版本信息

@todo description

包含了待完成工作的信息,或者待解决问题的信息

@version 

指定了元素的当前版本号

常用的phpdoc标签

标签:技术   解决问题   如何使用   format   作用   生成   desc   指针   其它   

原文地址:https://www.cnblogs.com/renranran/p/10736777.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!