`
pengjun1128
  • 浏览: 16041 次
  • 性别: Icon_minigender_1
  • 来自: 河南
社区版块
存档分类
最新评论

php DOC类型注释的用法

    博客分类:
  • php
阅读更多
/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category  组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息
* @example 示例
* @exclude 指明当前的注释将不进行分析,不出现在文挡中
* @final 指明这是一个最终的类、方法、属性,禁止派生、修改。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量,并加入相应的超级连接。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性。
* @version 定义版本信息
*/


分享到:
评论

相关推荐

    augmented_types, 用于强制参数和返回类型注释的PHP扩展.zip

    augmented_types, 用于强制参数和返回类型注释的PHP扩展 扩展类型扩展类型是一个PHP扩展,它在运行时强制phpdoc样式类型注释。 它与操作码cachers兼容...用法增强类型要求使用有效的PHPDoc注释所有类型的强制函数和方法

    phpdoc-to-typehint:使用PHPDoc批注添加标量类型提示并向现有PHP项目返回类型

    phpdoc-to-typehint使用现有PHPDoc注释自动将标量类型提示和返回类型添加到PHP项目的所有函数和方法中。 警告:该项目是开发的早期阶段。 它可能会损坏您的代码。 确保在运行此命令之前进行备份,然后再运行测试...

    api-doc-php:根据接口注释自动生成接口文档

    方法一:composer命令 composer require itxq/api-doc-php 方法二:直接下载压缩包,然后进入项目中执行 composer命令 composer update 来生成自动加载文件 引用扩展: 当你的项目不支持composer自动加载时,可以...

    doc-parser:文档解析器,doc块和注释(完全符合phpDoc和doctrine注释)

    和简单的用法: var DocParser = require ( 'doc-parser' ) ; var reader = new DocParser ( ) ; var data = reader . parse ( '/** @hello world */' ) ; 支持的语法 /** * Some description * @return ...

    开源文档管理系统LogicalDOC v6.3.rar

    文件夹可分层次组织,搜索使用集成搜索引擎,或通过标签浏览。通过插件体系可方便进行功能扩展。除了象关键字钻取和版本控制外,新的功能如搜索书签、EMAIL目录和工作流历史等完善了其基本的功能集。 LogicalDoc的...

    PHP静态分析器phan.zip

    支持 @param, @return, @var 和 @deprecated phpdoc 注释包括 union 和 void/null typesChecks for Uniform Variable Syntax PHP 5 -> PHP 7 BC breaks未定义的变量跟踪支持的命名空间,特征和variadics泛型 (from ...

    phpdoc-md:以降价格式生成文档

    phpdoc-md是一个从PHPDOC注释生成美观文档的工具。 它允许生成易于阅读的文档降价文件,并直接在github,gitlab或bitbucket网站上关注。 您可以在此工具生成的示例文档 该工具的意图与标准PHPDocumentator略有...

    通过代码注释轻松地为yii2生成在线api文档-PHP开发

    易于通过yii2的代码注释生成在线api文档Yii2批注生成API文档扩展yii2-api-doc易于通过yii2的代码注释生成在线api文档安装安装此扩展的首选方法是通过composer。 运行composer require --prefer-dist zhuzixian520 / ...

    php-annotations::high_voltage:一个为您的项目提供简单,懒惰,快速和轻量级学说注释和PHP 8属性阅读器的库

    Biurad PHP注释 ... 使用这个库,我们使您的工作变得更轻松,您所需要的只是Biurad\Annotations\ListenerInterface的实例和用于查找注释或属性的带注释的类。 要了解有关如何使用该库的更多信息,请尝试遍

    第二章 PHP入门基础之php代码写法

    一.在web页面嵌入PHP代码的几种风格 推荐使用标准风格或简短风格 复制...php //单行注释 /* * 多行注释 */ #shell风格注释 /** * PHPdoc风格注释 */ ?> 三.向浏览器输出字符串的几种方法 复制代码 代码如下: <?ph

    swagger-php:一个PHP swagger批注和解析库

    从代码和现有的phpdoc注释中提取信息。 命令行界面可用。 ,以及入门指南。 异常错误报告(带有提示,上下文)安装(使用 ) composer require zircote/swagger-php 为了从任何地方使用cli,请在全局安装swagger-...

    ph-puml:用于PHP代码的PlantUML类图生成器

    或者使用plantuml.jar可执行文件生成所有受支持的格式(png,svg,乳胶等) 命名空间中的软件包生成类,接口和特征的继承关系生成类属性和方法签名,包括来自@var doc注释的类型提示从构造函数参数类型推断依赖关系...

    Java-Web程序设计题库.doc

    B、getServerInfo() C、getServletPath() D、getServerPort() 17、能够获取当前页信息并调用页面方法的对象就是( B ) A、request B、page C、PageContext D、session 18、以下操作中,( A )就是与使用JavaBean无关的...

    Java-Web程序设计题库(1).doc

    C、getServletPath()D、getServerPort() 17、能够获取当前页信息并调用页面方法的对象是( B ) A、requestB、page C、PageContextD、session 18、以下操作中,( A )是与使用JavaBean无关的。 A、jsp:includeB、...

    Java-Web程序设计题库(2).doc

    A、指令 B、注释 C、脚本元素 D、操作 5、以下选项中,那一项不就是JSP指令( B )。 A、page B、import C、include D、taglib 6、下面哪种数据类型就是基本类型( D )。 A、class B、interface C、...

    phpGrib:PHP中的GRIB(网格化二进制)解析器

    现在,API文档可以作为类中PHPDoc注释使用。 示例文件夹中提供了一些用法示例(通过php命令行运行)。 抱歉,目前缺少文档 版权 该库是根据MIT许可( )许可的。 随时使用,修改和重新分发。 :)

    docker-compose-lemp-stack:Docker撰写Linux Nginx MariaDB PHP7.2堆栈

    Docker Compose LEMP堆栈 该存储库包含一些由docker-compose配置,用于启动LEMP (Linux, Nginx, MariaDB, PHP)堆栈。... 使用以下命令克隆该存储库: git clone https://github.com/stevenliebregt/doc

    nette-lattecs:拿铁的编码标准验证器

    *} doc 注释和正确格式化的@param注释关闭在同一行上的块不会被强制带有注释(例如标题或脚本块) 强制块内容缩进例子 ➜ lattecs git:(master) ✗ php bin/lattecs tests/fixtures/tests/fixtures/invalid_param....

    ReflectionDocBlock:提供 DocBlock 解析器的 phpDocumentor 组件-开源

    phpDocumentor 的 ReflectionDocBlock 组件提供了一个与 PHPDoc 标准 100% 兼容的 DocBlock 解析器。 有了这个组件,库可以通过 DocBlocks 提供对注释的支持,或者以其他方式检索嵌入在 DocBlock 中的信息。 为了...

    PhpDocumentor 2安装以及生成API文档的方法

    官网地址:http://www.phpdoc.org/项目地址:https://github.com/phpDocumentor/phpDocumentor2 phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序。 基于phpdocumentor 1和javadoc启发而来,它持续...

Global site tag (gtag.js) - Google Analytics