常用的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>,包含 ...
随机推荐
- socket应用(vue、node.js、M站)
socket应用(vue.node.js.M站) 前言:我们在做一些项目的时候需要做到实时变化, 比如我们有时候有需求会要求我们做一个类似于聊天室的页面 比如有些时候我们对某些东西进行点赞和刷票,需要 ...
- Spring Boot:Web 综合开发
Web 开发 Spring Boot Web 开发非常的简单,其中包括常用的 json 输出.filters.property.log 等 json 接口开发 在以前使用 Spring 开发项目,需要 ...
- onceAgain, 这是一个py群的群公告说明
群规: 1. 不骚扰人 2. 不涉及娱乐政治 3. 主要就这两条 入门参考:https://book.douban.com/review/9547077/ qq群/网盘:523445644 # 加群 ...
- wholesale custom weighted blankets / travel weighted blankets
What is weighted blankets? Weighted blanket named heavy gravity blanket,for child and adult. Help re ...
- linux挂载数据盘步骤
Linux添加新硬盘自动挂载硬盘的具体步骤 1.插入新硬盘,启动Linux服务器,使用fdisk -l 查看硬盘 #fdisk -l Disk /dev/sdb: 100GB, *********** ...
- UVa 11389 - The Bus Driver Problem 难度:0
题目 https://uva.onlinejudge.org/index.php?option=com_onlinejudge&Itemid=8&page=show_problem&a ...
- C_program assignment 2
/* Name: C program assignment 2 Copyright: Author: ShiroKa_X Date: 22/03/17 14:07 Description: */ #i ...
- laravel 记录
1.处理ajax跨域 使用 composer require barryvdh/laravel-cors
- generator mybatis逆向工程
mybatis逆向工程:根据数据库中的表在项目中生成对应的 实体类,dao接口与mapper.xml映射文件 在eclipse中,以插件的形式的存在,把设置好的配置文件,直接通过eclipse中的插件 ...
- login.html
<meta name="viewport" content="width=device-width, initial-scale=1,maximum-scale=1 ...