常用的phpdoc标签
| 标签 | 说明 |
|
@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标签的更多相关文章
- HTML之:fieldset——一个不常用的HTML标签
2016年4月14日17:10:02记录 一个不常用的HTML标签fieldset,不过我觉得比较有意思,其语法如下: <fieldset><legend>fieldset名称 ...
- JSP 标准标签库(JSTL)之最常用的JSTL标签总结
JSP标准标签库(JSTL)是一个JSP标签集合,它封装了JSP应用的通用核心功能. Apache Tomcat安装JSTL 库步骤如下: 从Apache的标准标签库中下载的二进包(jakarta-t ...
- 常用HTML meta 标签属性(网站兼容与优化需要),meta标签
常用HTML meta 标签属性(网站兼容与优化需要),meta标签 标签提供关于HTML文档的元数据.元数据不会显示在页面上,但是对于机器是可读的.它可用于浏览器(如何显示内容或重新加载页面),搜索 ...
- Django常用的模板标签
django 目前了解的各个文件的作用: manage.py: 运行服务 urls: 路由 views: 处理数据 传递给 html模板 html文件: 通过 {{变量名}}接收变量 通过 模板标 ...
- css的reset和常用的html标签的默认样式整理
先看下常用的这些标签浏览器的默认样式有哪些: body{ margin: 8px;} hr{ border:1px inset; margin-top:.5em;margin-bottom:.5em; ...
- html中的一些常用的样式标签
html中的一些常用的样式标签 <p>这里是文本,<mark>高亮</mark></p> <strong>加粗,加重语气</stron ...
- 自动回复之实现随机回复与常用Mapper XML标签
[常用Mapper XML标签] 1.基本的:select.insert.update 等 2.可读性.方便拼SQL:where.set.trim 3.减少重复:sql 4.逻辑控制:if.choos ...
- HTML中常用的部分标签(一)
[常见的块级标签] 标题标签<h1></h1>...<h6></h6> 水平线<hr/> 段落<p></p> 换行& ...
- 转:常用的HTML标签和属性解释
基本结构标签: <HTML>,表示该文件为HTML文件 <HEAD>,包含文件的标题,使用的脚本,样式定义等 <TITLE>---</TITLE>,包含 ...
随机推荐
- 如何练习打字之用英文写文章 & 如何调养右手之用左手握鼠标
part1:how to practise your typing via writing a English blog it's easy to write english for chinese. ...
- VIPKID 内推---开发工程师
VIPKID 目前是K12教育领域最大的一家公司,目前已发展到6w名北美外教,服务于中国50w的小朋友,每天数十万节视频课程在线上进行. 有兴趣加入VIPKID的程序员小伙伴,请发简历到 gloryz ...
- python之路-变量
变量定义的规则: - 变量名只能是字母.数字.或下划线的任意组合 - 变量名的第一个字符不能是数字 - 以下关键字不能声明为变量名 ['and','as','assert','break','cla ...
- mybatis Interceptor拦截器代码详解
mybatis官方定义:MyBatis 是一款优秀的持久层框架,它支持定制化 SQL.存储过程以及高级映射.MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集.MyBatis ...
- 使用Python统计函数绘制复杂图形matplotlib
一.堆积图 1.堆积柱状图 如果将函数bar()中的参数bottom的取值设定为列表y.列表y1代表另一个数,函数bar(x,y1,bottom=y,color="r")就会输出堆 ...
- Vscode下的Markdown的基本使用
1.Vscode默认支持Markdown语法,只需要安装相应的扩展插件,Markdown Preview enhanced. 2.安装完插件后,在Vscode上新建一个文件,然后将文件的语言模式设置为 ...
- 20190219备份 java spring boot 学习链接(日/英)
Building web applications with Spring Boot and Kotlin https://www.slideshare.net/masuda220/spring-82 ...
- python day18 作业 Django 开发主机管理系统
http://www.cnblogs.com/liang2580/p/9248803.html
- MySQL【数值处理函数】的使用方法
数值处理函数 下边列举一些数学上常用到的函数,在我们的业务中有数学计算时会很有用的: 名称 调用示例 示例结果 描述 ABS ABS(-1) 1 取绝对值 PI PI() 3.131593 返回圆周率 ...
- logging日志——Basic Logging Tutorial
在logging.basicConfig()函数中可通过具体参数来更改logging模块默认行为,可用参数有: filename,filemode,datefmt,format,level,strea ...