草庐IT

php - PHPDoc 中的闭包语法

我在PHPDoc中找不到任何关于闭包类型的文档。所以我的问题是如何定义发送到闭包的参数的参数及其返回值?例子:我如何描述“回调”将获得一个“MyCustomClass”、一个数字和一个字符串,并返回一个“MyOtherCustomClass”?/***@paramMyCustomClass$cls*@paramClosure$callbackthisisn'treallyexplainingwhatthisis**@returnMyOtherCustomClass*/functionchanger($cls,$callback){return$callback($cls,2,"astr

php - 如何使用 PHPDoc 对 Callable 的参数进行类型提示?

我有一个接受回调作为参数的方法。我想在PHPDoc中为类方法提供一个签名,其中概述了要传递给该方法的回调函数的参数,以便我的IDE(PHPStorm)可以为传递给我的方法的函数生成有效的类型提示,或者至少查看代码的人可以确定他们打算提供的回调的签名。例如:classFoo{public$items=[];/***@paramCallable(*@paramArrayObject$itemsThelistofitemsthatbar()willreturn*)$bazAcallbacktoreceivetheitems**/publicfunctionbar(Callable$baz){

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

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

phpDoc 类常量文档

我如何记录phpDoc的类常量?我已阅读手册,但找不到有关它们的任何信息。 最佳答案 常量只需要一个包含描述的文档block。不需要特定的标签。代码解析器本身识别常量并在生成的文档中显示它们(here'sanexample)。 关于phpDoc类常量文档,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/3892063/

php - 使用 PHPDoc 显示多行 @param 的正确方法是什么?

根据我所做的研究,我似乎无法找到一种正确的方法来格式化多行phpdoc@param行。推荐的方法是什么?这是一个例子:/***Prints'HelloWorld'.**Printsout'HelloWorld'directlytotheoutput.*CanbeusedtorenderexamplesofPHPDoc.**@paramstring$nounOptional.Sendsagreetingtoagivennouninstead.*Inputisconvertedtolowercaseandcapitalized.*@parambool$surpriseOptional.Ad

php - 如何将 PHP 代码块放入 PHPDoc DocBlock

我正在使用PHPDoc,并意识到您可以使用markdown向DocBlock添加一些格式。特别是,我注意到您可以使用反引号来突出显示内联代码。但是,我似乎不知道如何将代码块添加到DocBlock,因为使用4个空格似乎不起作用。我尝试过使用和同样,虽然这些标签确实出现在生成的文档中,但其中的代码会被HTML注释注释掉。例如,这个DocBlock:/***ThisisatestDocBlock******@returnobject[]Anarrayofobjects.*/生成此HTML:我哪里错了?如何将代码块添加到我的DocBlock? 最佳答案

php - 我应该如何 PHPDoc 回调?

我有一个方法可以从数据库中提取经过修改的预序树横向树,并使用回调函数对其进行过滤。例如:/***RecursivefunctionforbuildingtheCas_Template_TreeNode.**@static*@paramarray$rows*@paramcallback$filterAfunctiontofilterthetreeby(returnavalueconvertibletofalsetoremovetheitemfromthetree)*@returnarray*/privatestaticfunctionMakeTreeGivenDbRows($rows,$

php - 记录(phpdoc)生成器的最佳方法(产生的方法)

对于phpdocumentor2来说,记录生成器方法的最佳方式是什么。我不认为@return真的适用于yield,但我似乎找不到任何合适的替代方法。是否只是等待phpdoccatch来的问题? 最佳答案 我选择了@returnGenerator|SomeObject[],其中SomeObject是要生成的东西。PhpStorm也能很好地处理这个问题,因为它现在通常会提示Generator方法,并且在迭代时会提示SomeObject方法。(不过,我更喜欢原生@yield。) 关于php-记

PHPDoc:@return void 有必要吗?

真的有必要这样做吗:/***...**@returnvoid*/我有很多方法没有返回值,在评论中放这样的东西似乎真的是多余的。将其排除在外会被认为是不好的形式吗? 最佳答案 如果文档清楚,则保留它,但这不是绝对必要的。这是一个完全主观的决定。就我个人而言,我会忽略它。编辑我站得更正了。经过一番谷歌搜索,wikipediapage说:@return[typedescription]Thistagshouldnotbeusedforconstructorsormethodsdefinedwithavoidreturntype.phpdo

php - 为常量编写 PHPDocs 的正确方法是什么?

我有这个代码:/***Daystoparse*@varint*/constDAYS_TO_PARSE=10;...我不认为使用@var对常量是正确的,我没有看到任何@constantPHPDoc标记。这样做的正确方法是什么? 最佳答案 ThePHP-FIGsuggestsusing@varforconstants.7.22.@varYoumayusethe@vartagtodocumentthe"Type"ofthefollowing"StructuralElements":Constants,bothclassandglobals