草庐IT

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

我正在努力编写可读且易于理解的文档来描述传递给函数的数组选项的多树结构。这是一个示例数组结构。$arr=['fields'=>['title'=>['name'=>'Document.title','format'=>'string','readonly'=>true]]];上面的数组有很多可能的选项,但它被用作理解该结构的函数的参数。functiondoSomething(array$arr){...}我想在PHPDoc中记录数组的结构,但我不确定正确的方法是什么。这是我现在拥有的。/***Holdsconfigurationsettingsforeachfieldinamodel.

php - 使用 PhpDoc 记录 PHP 多重继承

我有像这样的多重继承:CanIextendaclassusingmorethan1classinPHP?(请不要讨论这种方法本身)并希望我的IDE了解继承的类方法和属性。有没有办法用PhpDoc做到这一点? 最佳答案 目前看来没有办法轻松做到。我在PhpStorm问题跟踪器上创建了一张票。也许他们会添加对此功能的支持。http://youtrack.jetbrains.net/issue/WI-1730 关于php-使用PhpDoc记录PHP多重继承,我们在StackOverflow上找

php - PHPDoc 中严格类型实体的提示迭代器

细节我正在使用PHPStorm8IDE。假设我们有一些实现了\Iterator的类Foo接口(interface),我们知道该迭代器中的所有项目都是Bar类的实例。问题如何提示Foo是可迭代的并且只包含Bar的项目?当然,提示应该保留信息,它是Foo的实例到目前为止我尝试了什么如果我们有一个Bar实例数组,那么这很容易(例如,在this问题中对其进行了描述):Bar[]。此外,如果打算遍历Foo,它仍然可以(或多或少)解决://assumethat$fooisinstanceofFoo//../*@var$objectBar*/foreach($fooas$object){}但是,有一

phpdoc:记录常量的正确方法是什么

是否有适当的方法来记录使用define()定义的常量?@var真的没有意义。我唯一能想到的就是省略标签,只在PHPdoc注释中写描述。 最佳答案 phpDocumentor不识别或使用@const标签。当phpDocumentor在代码中看到“define”关键字时,它会识别出一个常量。它的输出模板将显示输出文档中的所有常量,列为常量。常量的docblock中唯一需要的是描述,但如果您觉得需要,也允许使用许多其他“标准”标签[1]。[1]--http://manual.phpdoc.org/HTMLSmartyConverter/H

php - 还有什么比 PHPDoc 更好的吗?

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭7年前。Improvethisquestion除PHPDoc外,还有其他任何东西来记录他们的PHP代码吗?是否有任何工具可以读取相同的文档语法但提供更丰富的输出?

php - 如何告诉 phpDoc 一个字符串是一个类名?

我经常给对象赋予静态方法和属性,不需要对象进行初始化。例如:classSomeObject{publicfunction__construct($object_id){$this->loadProperties($object_id);}publicstaticfunctiongetSomeStaticString(){return"somestaticstring";}}现在我们对这些对象进行子类化,并有某种Controller在某些情况下返回一个对象类字符串,此时对象还不应该被初始化。例如:classSomeObjectController{publicfunctiongetSom

php - 安装 phpdoc/phpDocumentor 包后无法运行 phpdoc 命令

虽然我按照说明安装了phpDocumentor,但命令行似乎没有响应phpdoc给定错误:未找到命令“phpdoc”,您的意思是:来自debphploc的命令'phploc'来自debphpdox的命令'phpdox'尝试:sudoaptinstall我按照这些步骤安装了phpdoc,它似乎可以工作pearchannel-discoverpear.phpdoc.orgpear安装phpdoc/phpDocumentor安装完成后,我尝试运行phpdoc-h但没有成功。使用:7.2.16操作系统:Ubuntu18.04.2LTS我很感激任何帮助的尝试。 最佳答

php - 可以让 PHP 解释器知道 PHPDoc 类型提示吗?

作为Emacs用户,我唯一羡慕像PDT这样的“现代”编辑器的是PDT理解类型,甚至PHPDoc“类型提示”,例如/***@paramDateTime$date*@paramstring$name*@returnDOMDocument*/目前,我尽可能使用类型提示,让PHP解释器在参数类型错误时提醒我,但这仅在参数是对象时有效。更重要的是,无法确保函数的返回值是特定类型。这可能是一个远景,但是否有任何插件或其他方法可以使PHP解释器以与PDT相同的方式识别PHPDoc注释?理想情况下,如果我返回一个错误类型的值,或者如果我传递一个我已将参数声明为int的字符串,我希望得到fatalerr

php - 请求参数和 phpdoc

这个问题在这里已经有了答案:关闭11年前。PossibleDuplicate:IsthereastandardfordocumentingGET/POSTparameters?试图找出以一种有意义的方式通过phpdoc记录请求参数的最佳方式。具体来说,我有一些通过GET/POST接收参数但不是功能参数的ZendFrameworkController操作。这有意义吗?/***Displayapagination/gridlistofrows.**@paramstring$_GET['order']Whatfieldtosorton*@paramstring$_GET['dir']Dire

PHPdoc:记录可链接的方法?

我应该如何正确使用PHPdoc来记录类中的可链接方法,如以下示例所示-正确用法是什么?classmyClass{/***@returnmyClass*/functionone(){return$this;}/***@returnself*/functiontwo(){return$this;}/***@return$this*/functionthree(){return$this;}} 最佳答案 /***@returnmyClass*/我不是phpDoc专家,但他们在Zend框架中就是这样做的。所以我觉得靠谱