草庐IT

php - 如何在phpdoc中使用@package和@subpackage?

我想知道我应该如何将@pa​​ckage和@subpackage用于类文档。假设我有以下类(class)classMy_Controller_Action_Helper_MyHelperActionextendsFoo_Bar{}应该是:@categoryMy@packageController@subpackageAction_Helper或@categoryMy@packageController@subpackageAction_Helper_MyHelperAction或@categoryMy@packageController_Action@subpackageMyHelpe

php - 在 phpDoc 语法中定义命名空间

谁能告诉我在phpDoc语法中定义php命名空间的正确方法是什么?或者,@package是否在phpDoc中被弃用,因为命名空间或多或少定义了一个包?如果没有,是否有一种通用的方法来记录文档所在的命名空间? 最佳答案 phpDoc没有命名空间的概念,但您可以(并且可能应该)使用@package。你可以看看phplintdocumentation看看他们是如何格式化命名空间的。 关于php-在phpDoc语法中定义命名空间,我们在StackOverflow上找到一个类似的问题:

php - bool 参数是否有 PHPDoc 类型提示?

我无法找到可以用PHPDoc提示的类型的概述。我知道数组或字符串,但还有bool值吗?喜欢:/***@paramboolloadLazy*@returnarrayArraywithobjects*/publicfunctiongetObjects($loadLazy=false){ 最佳答案 由于“类型提示”只是一个“提示”,我想说您可以使用任何您喜欢的东西。不过,我倾向于使用在官方PHP手册中找到的类型——这意味着,对于Boolean,我会使用boolean。 关于php-bool参数

php - 如何在 PhpDoc 中指定对象数组

这个问题在这里已经有了答案:PHPDoctypehintingforarrayofobjects?(14个答案)关闭去年。我使用PhpDocumentor2生成文档。我搜索了这个主题,但找不到它的具体规则。例如,我有一个名为AddressField的类,我想将我的$addressFields指定为AddressField对象数组。/***@varAddressField[]*/private$addressFields;

php - 如何在类定义之外为魔术属性创建 PHPDoc?

PHPDoc提供了@vartag,它甚至应该适用于在类外声明的变量。但是,如果我将变量定义为对象的魔术成员,这似乎不起作用:/**@var$app->translator\Fortress\MessageTranslator*/$app->translator=new\Fortress\MessageTranslator();$app是Slim支持通过魔术setter和setter/getter进行任意属性分配的对象。我知道我可以通过@property标签将它添加到Slim本身,但是我需要更改核心Slim每次创建新属性时都编写代码。PHPDoc支持这种动态属性文档吗?

php - 你能为一个类创建一个外部 PHPdoc 吗?

假设我有以下内容classSomethingextendsClassWithMagicMethods{}通常我会为我知道存在的任何属性添加一个文档block,即使通过魔术方法访问也是如此/***@propertystring$someVar*@methodSomeClassgetSomeClass()*/classSomethingextendsClassWithMagicMethods{}效果很好,但我想知道我们是否可以将该文档block与类的定义分开。两个可能的用例:不包含文档block的第三方包,但我希望从我的IDE自动完成-我希望能够在某处为其添加我自己的文档block。扩展系

php - 在 PHPDoc 中声明局部变量的属性

我有一个带有一些属性的stdClass实例。在PHPDoc中声明这些属性的正确方法是什么?我试过了,但似乎不行:/***@var$requestParamsstdClass*@propertystringcancelUrl*/$requestParams=$someObj->getSomething(); 最佳答案 鉴于您的代码示例,您可以做的最好的事情是通过@var表示$requestParams是stdClass类型。您对@property的使用不会为您做任何事情,因为该标记专门为类中存在的魔术属性定义...因此,@proper

php - 对于抽象函数,phpdoc 应该为抽象函数、实现函数还是两者定义?

是否有正确或标准的方法来执行此操作?例如:AbstractFoo.php:abstractclassAbstractFoo{/***Doesthephpdocgohere?*/publicfunctionfooFunction();}Foo.php:classFooextendsAbstractFoo{/***Ordoesthephpdocgohere?*/publicfunctionfooFunction(){//someimplementation}}考虑以下问题:如果您将phpdoc放在抽象的FooFunction()中,然后控制并单击$foo->FooFunction(),您将

php - 什么时候更新 PHPdoc 中的标签@author?

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭8年前。Improvethisquestion这真是一个新手问题。我正在努力提高我的PHP技能,所以我正在阅读一些库的代码。我注意到许多PHPdocheader(这是正确的名称吗?我的意思是:/***@param$config*@returnbool*@authordeveloper1*/)包含@author标签。假设developer2对developer1的功能进行了巨大的更改,然后提交到github。developer2是否应该

php - 如何指示该方法是 PHPDoc 接口(interface)的一部分?

如何指示该方法是PHPDoc接口(interface)的一部分?例如:/***@implementsBarInterface*/classFooimplementsBarInterface{/***@thisMethodIsHereBecauseItIsAPartOf("BarInterface")*/publicfunctiondoBar(){}}有什么适合替换@thisMethodIsHereBecauseItIsAPartOf("BarInterface")的东西吗? 最佳答案 Howtoindicatethatmethodi