phpdoc相关内容

对象数组的PHPDoc类型提示?

因此,在 PHPDoc 中,可以在成员变量声明上方指定 @var 以提示其类型.然后是 IDE,例如.PHPEd 将知道它正在使用什么类型的对象,并将能够为该变量提供代码洞察力. 这很有效,直到我需要对一组对象执行相同的操作,以便稍后在遍历这些对象时获得适当的提示. 那么,有没有办法声明一个PHPDoc标签来指定成员变量是一个SomeObj的数组呢?@var 数组是不够的,例如 @va ..
发布时间:2022-01-20 20:54:20 PHP

使用 PEAR 安装 phpDocumentor

在 http://www.phpdoc.org/ 的主页上,在 http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quickstart.pkg.html,以及 https://github.com/phpDocumentor/phpDocumentor2,安装 phpDoc ..
发布时间:2022-01-13 21:23:56 PHP

如何在没有自动 DocBlock 格式的情况下在 NetBeans 中进行多行注释?

有时在我的代码中我喜欢注释掉一段代码以供临时使用/引用等,例如: /*废话*/ 但是如果我想在那个块中插入一行,当我点击回车时,它会自动在下一行放一个 * ,就像我在做一个 DocBlock 一样,这是一个小烦恼.这发生在每个回车键上: /*等等**/ 现在我认为这种“自动格式化"应该只在开场评论使用格式/**(两颗星)时发生.多行注释在 DocBlocks 之前已经存在 ..
发布时间:2021-12-26 15:08:25 PHP

在 PHPDoc 中记录数组选项的最佳方式?

我正在努力编写可读且易于理解的文档,以描述传递给函数的数组选项的多树结构. 这是一个示例数组结构. $arr = ['字段' =>['标题' =>['名称' =>'文件名','格式' =>'细绳','只读' =>真的]]]; 上述数组有许多可能的选项,但它被用作理解该结构的函数的参数. function doSomething(array $arr) { ... } 我想记录如何在 ..
发布时间:2021-12-21 20:57:54 PHP

用于可变长度参数数组的 PHPDoc

是否有用于记录采用单个配置数组而不是单个参数的函数的语法? 我特别想到了 CodeIgniter 风格的库,它使用了类似的机制: $value) {$this->$key = $value;}}}////库使用:////初始化我们的配置参数$config['foo'] = 'test';$config['bar'] = 4;$config['baz'] = array('x', 'y', ..
发布时间:2021-12-10 13:44:05 PHP

如何在 PhpDocumentor 中显示继承方法的完整文档块?

我目前有代码,其中有一个抽象父类定义了一些具体方法,子类扩展了这个父类,并将使用具体方法.例如: 在我的 child_class 文档中,我看到我的 bar() 函数有很好的文档记录,包括方法摘要和方法的详细描述...但是我继承的 foo() 函数仅声明为继承我需要点击一个链接来查看它的完整文档,甚至只是看到它可以被这个函数调用.我所看到的一个例子显示在图像这里中.(我是新用户,不能放图片. ..
发布时间:2021-11-25 09:16:21 C#

是否有记录 GET/POST 参数的标准?

在一个 PHP 项目中,即使主应用程序使用前端控制器逻辑,也可能有很多独立的脚本、ajax 片段等. 是否有一种标准化的方式 - PHPDoc 或其他方式 - 在脚本的第一个注释块中定义脚本将接受/需要哪些 GET 和/或 POST 参数以及它们是哪种类型? 我通常通过添加 @param 来帮助自己,就好像文件是一个函数一样,以及一个 @return 解释脚本的作用和返回,但也许还有一 ..
发布时间:2021-11-22 17:08:20 PHP

PHP Documentor 中的注释关联数组

我在我的 PHP 应用程序中使用了几个关联数组,并且我正在使用 PHP 文档器来注释我的源代码.我从来没有真正为数组中的数组指定注释,但现在我需要这样做,但不知道如何做. $array = array('id' => 'test', 'class' => 'tester', 'options' => array('option1' => 1, 'option2'=> 2)) 我如何以正确的方式 ..
发布时间:2021-11-18 02:18:37 PHP

Aptana 不会为类中的函数生成 phpdoc 块

在 Aptana 中,我以某种方式破坏了为类中的函数自动生成 phpdoc 注释的功能.它似乎只影响我当前的项目. 通常我可以在函数前的一行中输入/** 并按回车键,Aptana 将使用正确的 @param 值等创建一个 phpdoc 注释.出于某种原因,当我现在这样做时,Aptana 创建了 2 个注释,一个在另一个内.例如 /***/****/*/公共静态函数 getByLogin($ ..
发布时间:2021-11-17 01:08:08 其他开发

是否有正确的方法来通知注释解析器忽略文档块内的注释?

假设我有一个 docblock 注释,例如,它被 phpDocumentor 和任何注释解析器(假设是 Doctrine common)解析. 现在,我不希望 @DIC\Service 注释被默认解析,除非用户希望它被解析......显然我可以做任何事情来防止它:存储它在手册页而不是内联页中,将其放在非文档块注释中,等等. 是否有一种正确且相对标准的方式来通知注释解析器内联,以忽略 ..
发布时间:2021-11-10 23:19:59 PHP

是否有正确的方法来通知注释解析器忽略文档块内的注释?

假设我有一个 docblock 注释,例如,它被 phpDocumentor 和任何注释解析器(假设是 Doctrine common)解析. 现在,我不希望 @DIC\Service 注释被默认解析,除非用户希望它被解析......显然我可以做任何事情来防止它:存储它在手册页而不是内联页中,将其放在非文档块注释中,等等. 是否有一种正确且相对标准的方式来通知注释解析器内联,以忽略 ..
发布时间:2021-11-10 23:17:08 PHP

VIM 自动插入 PHPdoc

有没有办法使用命令或组合键在 VIM 中插入 PHPDoc? 例如,我有一个类: class MyClass{公共函数 __construct() { }公共函数 __destruct() { }/* 此处插入 PHP 文档的命令 */公共函数 abc() { }} 我想插入如下内容: /*** 方法()** 描述** @使用权* @作者* @param type $varname 描 ..
发布时间:2021-09-17 20:57:08 其他开发

json_decode-d 对象的 PHP 文档块

我从 PHP 代码中的 JSON 字符串获取对象.我希望我的 IDE (NetBeans) 知道对象的参数,而无需为它们创建特殊的类. 我可以吗? 它看起来像: $obj = json_decode($string);/*** @var $obj {* @property int $id* @property 字符串 $label* }*/ 解决方案 这是它的结构化版本 首 ..
发布时间:2021-09-11 19:54:55 PHP

在 symfony2 上使用 phpDocumentor

我安装了一个新的 symfony 2.4 项目,并按照以下步骤使用 composer.phar 安装了 phpDocumentor: 1- 添加:“需要开发":{"phpdocumentor/phpdocumentor": "2.*"到我的 composer.json 2- 执行:php composer.phar 更新 安装终止后,我可以在/vendor 中看到 phpdocu ..
发布时间:2021-09-03 19:43:22 PHP

phpDocumentor - 无法打开输入文件:phpdoc.php

我正在尝试使用 phpDocumentor(第一次,我不知道我在做什么).实际上,我只想将它与 SublimeText 2 和 this 插件一起使用.你能一步一步指导我我该怎么做才能让它工作?这是我现在所做的:(我使用的是 Windows 7)从这里下载phpDocumentor并将其放置在某处.我已经为 phpdoc/bin 创建了系统路径(因此 phpdoc.bat 可以由 sublime ..
发布时间:2021-08-31 20:10:44 PHP

Sublime Text 2 评论/文档块

最近,我决定尝试使用 Sublime Text 2 作为 TextMate 的替代品(确实如此).我非常喜欢它,但唯一困扰我的问题是按下“Enter"后它不会继续 PHP 注释/文档块. 它只是添加新的空行而不是以“*"开头的行,如下所示http://cl.ly/AFcP/o 有没有办法解决这个问题?我尝试为它做一个键绑定,但对我来说太复杂了,尤其是因为我对编辑器没有太多经验. ..
发布时间:2021-08-31 20:02:58 其他开发