标签 说明

@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标签的更多相关文章

  1. HTML之:fieldset——一个不常用的HTML标签

    2016年4月14日17:10:02记录 一个不常用的HTML标签fieldset,不过我觉得比较有意思,其语法如下: <fieldset><legend>fieldset名称 ...

  2. JSP 标准标签库(JSTL)之最常用的JSTL标签总结

    JSP标准标签库(JSTL)是一个JSP标签集合,它封装了JSP应用的通用核心功能. Apache Tomcat安装JSTL 库步骤如下: 从Apache的标准标签库中下载的二进包(jakarta-t ...

  3. 常用HTML meta 标签属性(网站兼容与优化需要),meta标签

    常用HTML meta 标签属性(网站兼容与优化需要),meta标签 标签提供关于HTML文档的元数据.元数据不会显示在页面上,但是对于机器是可读的.它可用于浏览器(如何显示内容或重新加载页面),搜索 ...

  4. Django常用的模板标签

    django 目前了解的各个文件的作用: manage.py:  运行服务 urls: 路由 views: 处理数据 传递给 html模板 html文件:  通过 {{变量名}}接收变量 通过 模板标 ...

  5. css的reset和常用的html标签的默认样式整理

    先看下常用的这些标签浏览器的默认样式有哪些: body{ margin: 8px;} hr{ border:1px inset; margin-top:.5em;margin-bottom:.5em; ...

  6. html中的一些常用的样式标签

    html中的一些常用的样式标签 <p>这里是文本,<mark>高亮</mark></p> <strong>加粗,加重语气</stron ...

  7. 自动回复之实现随机回复与常用Mapper XML标签

    [常用Mapper XML标签] 1.基本的:select.insert.update 等 2.可读性.方便拼SQL:where.set.trim 3.减少重复:sql 4.逻辑控制:if.choos ...

  8. HTML中常用的部分标签(一)

    [常见的块级标签] 标题标签<h1></h1>...<h6></h6> 水平线<hr/> 段落<p></p> 换行& ...

  9. 转:常用的HTML标签和属性解释

    基本结构标签: <HTML>,表示该文件为HTML文件 <HEAD>,包含文件的标题,使用的脚本,样式定义等 <TITLE>---</TITLE>,包含 ...

随机推荐

  1. mybatis源码数据库链接配置

    <?xml version="1.0" encoding="UTF-8" ?>  <!DOCTYPE configuration        ...

  2. python中的turtle库(图形绘画库)

    turtle绘图的基础知识:1. 画布(canvas) 画布就是turtle为我们展开用于绘图区域,我们可以设置它的大小和初始位置. 设置画布大小 turtle.screensize(canvwidt ...

  3. Spring-----入门

    Spring 入门 一.首先导入核心jar包 commons-logging-1.1.3.jar                 日志        spring-beans-4.2.4.RELEAS ...

  4. 编码 decode & encode

    import sys # python3 中字符编码默认为 utf-8 s = '你好' print(s) # utf-8 转为 gbk (s 默认为 unicode 所以可以直接 encode 成 ...

  5. tensorflow (七) k-means

    tensorflow基础暂不介绍 Python 相关库的安装 在进入正式聚类实验之前,我们还需要配置计算及画图需要用到相关支持包. 安装 seaborn: pip install seaborn 安装 ...

  6. 关于visual studio的一些日常总结

    一.常用的VS快捷键 批量注释:ctrl + k ctrl + c 批量解除注释:ctrl + k ctrl + u 转到声明:ctrl + F12 查找:ctrl + F 添加断点:F9 逐过程调试 ...

  7. 活代码LINQ——02

    一.复习基础——属性与实例变量 'Fig. 4.8:GradeBookTest.vb 'Create and manipulate a GradeBook object. Module GradeBo ...

  8. 表单传参,在action中的参数得不到

    写上面这个的时候,发现传过去的url路径是这样的 在action后面的pro=login得不到. 只需要将method中的get改成post就可以了

  9. jquery.validate.js使用实例

    一.常用方式: $('form').validate({  rules: {},        messages: { },        submitHandler: function () {}) ...

  10. SpringBoot项目如何打War包

    首先,需要添加Tomcat启动依赖 <dependency> <groupId>org.springframework.boot</groupId> <art ...