phpDocumentor 注释语法详解

PHPDocumentor是强大的代码注释生成器,本文对各个参数进行了简单地的总结:

@abstract
-------------
使用@abstract标记来声明一个方法,类变量或类必须重新定义子类中是有效的。

@abstract
-------------
使用@abstract标记来声明一个方法,类变量或类是抽象的。
一个类中,只要有一个抽象方法,这个类必须被声明为抽象类。
抽象方法在子类中必须被重写。
抽象类在被继承后,其中的抽象方法不能被重写。

@access
-------------
访问权限public、protected、private

@author
-------------
作者

@category
-------------
分类,例如(library,helper,view等)

@copyright
-------------
版权

@deprecated
-------------
过时的,即将被弃用

@example
-------------
包括带有语法高亮的外部示例文件

@final
-------------
final类不能被继承,final方法不能被重写

@filesource
-------------
创建包含当前文件和链接的,语法高亮显示的参照文件源代码

@global
-------------
全局变量

@ignore
-------------
使用@ignore防止文档记录的元素,如重复的元素。

@internal
-------------
标记为私有,软件项目内部的

@license
-------------
指向许可文件的超链接

@link
-------------
超链接

@method
-------------
一个类的“魔术”方法

@name
-------------
phpDocumentor识别global变量中的@name标记(结合@global),用它来重命名一个文档的global变量以增强可读性。一个global变量必须以($)开始,否则phpDocumentor会忽略此标记并报错。

@package
-------------
指定包来组织类或方法。@package只能用于文档程序页面或类。

@param
-------------
函数的参数

@property
-------------
“魔术”属性

@return
-------------
指定一个函数或方法的返回值类型

@see
-------------
指向元素的文档的链接

@since
-------------
从哪个版本开始将其添加进package

@static
-------------
静态属性或方法,无需实例化即可调用

@staticvar
-------------
函数或方法中的静态变量

@subpackage
-------------
和@package一起为文档组织php文件

@todo
-------------
未来可能有变动

@tutorial
-------------
显示一个指向该文件的教程

@uses
-------------
显示指向元素的文档的链接,并创建一个反向链接在其他元素的文档

@var
-------------
变量

@version
-------------
版本

转自:www.zf-bbs.com

时间: 2024-08-03 20:32:56

phpDocumentor 注释语法详解的相关文章

discuz门户首页-header文件模板语法详解和注释

header文件引用了跟多通用模板,所以整个文章会很长,现在比较忙,注释工作会不定期进行 首先开下门户首页的文件 portal里面的index.htm <!--{template common/header}--> //引用common文件下的header.htm这个也是引用模板文件的一种常用方法 <style id="diy_style" type="text/css"></style> //没什么用 <div class

Hadoop Hive sql语法详解

Hive 是基于Hadoop 构建的一套数据仓库分析系统,它提供了丰富的SQL查询方式来分析存储在Hadoop 分布式文件系统中的数据,可以将结构化的数据文件映射为一张数据库表,并提供完整的SQL查询功能,可以将SQL语句转换为MapReduce任务进行运行,通过自己的SQL 去查询分析需要的内容,这套SQL 简称Hive SQL,使不熟悉mapreduce 的用户很方便的利用SQL 语言查询,汇总,分析数据.而mapreduce开发人员可以把己写的mapper 和reducer 作为插件来支持

JSP语法详解

转自:http://www.cnblogs.com/culffe/articles/1142388.htm ———————————————————————————————————— 1)HTML注释: <!-- 注释内容 [ <%= 表达式 %> ] --> 可以用注释内容,也可以用表达式. 2)隐藏注释: <%-- 注释内容 --%> 注释会被JSP编译时被忽略.编译器不会对<%-- --%>之间的语句编译,它不会显示在客户的浏览器和源代码中. 3)声明:

Velocity魔法堂系列二:VTL语法详解

一.前言 Velocity作为历史悠久的模板引擎不单单可以替代JSP作为Java Web的服务端网页模板引擎,而且可以作为普通文本的模板引擎来增强服务端程序文本处理能力.而且Velocity被移植到不同的平台上,如.Net的NVelocity和js的Velocity.js,虽然各平台在使用和实现上略有差别,但大部分语法和引擎核心的实现是一致的,因此学习成本降低不少哦. 最好的学习资源——官网:http://velocity.apache.org/ 本系列打算采用如下结构对Velocity进行较为

SQLSERVER存储过程语法详解

SQL SERVER存储过程语法: Create PROC [ EDURE ] procedure_name [ ; number ]     [ { @parameter data_type }         [ VARYING ] [ = default ] [ OUTPUT ]     ] [ ,...n ] [ WITH     { RECOMPILE | ENCRYPTION | RECOMPILE , ENCRYPTION } ] [ FOR REPLICATION ] AS sq

DockerFile 编译语法详解(5)

title: DockerFile 编译语法详解(5) date: 2018-12-16 16:53:20 tags: Docker categories: Docker copyright: true --- Docker是基于Go语言实现的开源容器项目,Docker让开发者可以打包他们的应用以及依赖包到一个可移植的容器中,然后发布到任何流行的 Linux 机器上,也可以实现虚拟化.容器是完全使用沙箱机制,相互之间不会有任何接口,Docker诞生于2013年年初,最初发起者是dotCloud公

Java8初体验(二)Stream语法详解

原文链接:http://ifeve.com/stream/ 1. Stream初体验 我们先来看看Java里面是怎么定义Stream的: A sequence of elements supporting sequential and parallel aggregate operations. 我们来解读一下上面的那句话: Stream是元素的集合,这点让Stream看起来用些类似Iterator: 可以支持顺序和并行的对原Stream进行汇聚的操作: 大家可以把Stream当成一个高级版本的

[持续交付实践] pipeline:pipeline 使用之语法详解

一.引言 jenkins pipeline语法的发展如此之快用日新月异来形容也不为过,而目前国内对jenkins pipeline关注的人还非常少,相关的文章更是稀少,唯一看到w3c有篇相关的估计是直接翻译软件翻的,读下来惨不忍睹.没办法,语法详解这章我干脆把jenkins官网上的语法说明全部翻译了一遍,并更新了陈旧的内容(可怜了我大学四级的英语水平~),英语好的朋友也可以直接到官网阅读. 二.语法简介 Pipeline最基本的部分是"step".基本上,step告诉Jenkins 要

less中的部分语法详解

less中的语法详解,主要是介绍一些平时常用的语法,如果有更多更实用的语法欢迎大家和我交流. 一.变量. 变量是识别符号是@,在less中以@开头的则是变量,关于变量名的命名方法,大家可以参考js中命名的规则,毕竟是做前端的,有着统一的习惯有助于我们统一风格.个人推荐变量名的命名规则使用驼峰命名法.第一个单词首写字母小写,从第二个开始,单词首写字母大写.如boxAaa,boxBbbb,boxContainer,……,当然也是可是使用香肠命名法用下划线“_”来命名.如,box_main,borde