常用的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>,包含 ...
随机推荐
- lr_java user协议脚本开发
1.准备工作,安装jdk,配置环境变量 lr11 jdk1.6 32位 lr12 jdk1.7 32位 注:若原已安装了jdk1.8,现要安装jdk1.7,若遇到安装好1.7并配置好环境后,在cmd中 ...
- 本地代码上传到git
1.(先进入项目文件夹)通过命令 git init 把这个目录变成git可以管理的仓库 git init 2.把文件添加到版本库中,使用命令 git add .添加到暂存区里面去,不要忘记后面的小数点 ...
- 关于warning: suggest parentheses around assignment used as truth value [-Wparentheses]|的解决方法
今天,在调试的时候一直出现warning: suggest parentheses around assignment used as truth value 代码如下: if(startTime== ...
- flask 第六章 人工智能 百度语音合成 识别 NLP自然语言处理+simnet短文本相似度 图灵机器人
百度智能云文档链接 : https://cloud.baidu.com/doc/SPEECH/index.html 1.百度语音合成 概念: 顾名思义,就是将你输入的文字合成语音,例如: from a ...
- ubuntu google chrome 全屏显示命令
全屏模式:kiosk默认全屏打开一个网页呢,只需要在快捷方式中加上 --kiosk [url] 就可以了.终端命令行打开: google-chrome --kiosk www.baidu.com 参考 ...
- 介绍一下Spring Cloud Config
Spring Cloud Config为分布式系统中的外部配置提供服务器和客户端支持.使用Config Server,您可以在所有环境中管理应用程序的外部属性.客户端和服务器上的概念映射与Spring ...
- spring cloud + spring boot + springmvc+mybatis分布式微服务云架构
做一个微服务架构需要的技术整理: View: H5.Vue.js.Spring Tag.React.angularJs Spring Boot/Spring Cloud:Zuul.Ribbon.Fei ...
- 1 实现添加功能 1.1 定义一个学员类(Student),在Student类中定义姓名、性别和年龄属性,定义有 参数的构造方法来初始化所以的成员属性 1.2 创建学员类对象来存放学员信息,并且为每一个学生对象添加的相应的编号。并将 学员类对象添加到Map<Integer,Student>集合中 1.3 添加完成后,显示所有已添加的学员姓名 1.4 限制年龄文本框只能输入正整数,否则的会采
学生类 package com.lanxi.demo1_3; public class Student { private String name; private String sex; priva ...
- java应用性能分析
dump内存信息 通过jps -lm找到进程id jmap -dump:format=b,file=./heap.hprof <pid> 使用jprofile等分析内存占用情况 dump线 ...
- Python 字典dict相关知识
字典是无序的,多次print输出的结果不一样. 字典的key可以是数字.字符串.元组.布尔值(True为1,False为0,不可以和其他key值重复):列表和字典不能作为key. 字典的value可以 ...