草庐IT

php - 使用 PHPDoc 自动添加 Git 版本

我想知道是否有人知道将文件/存储库的Git版本插入注释block以便PHPDoc可以在生成文档时自动反射(reflect)它的方法? 最佳答案 phpDocumentor不是将信息放入文档的工具...它必须已经出现在您的文档block中。听起来您已经习惯了在您的文档block中使用$Id$标签,当您检查代码时,这些标签会由CVS和SVN自动填充...也称为“关键字扩展”。Git确实允许这样做--https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#_keyword

php - 可迭代对象的正确 phpdoc 注释?

我在尝试为以下代码示例获取正确的自动完成时遇到了一些问题。我在Win7机器上使用PHPStorm7。首先只是一个简单的类。/***ClassmyObject*/classmyObject{/***somemethod*/publicfunctionmyMethod(){//dosomething}}这个是集合类,它可以包含先前类的多个实例并实现了IteratorAggregate接口(interface)。/***ClassmyCollection*/classmyCollectionimplementsIteratorAggregate{/***@varmyObject[]*/pro

PhpDoc 在类中包含的文件中为自己添加符号

我有一个类,它包含一个文件,方法如下:在class.php文件中:classA{constCONST1=5;/**@varint$a*/var$a=5;publicfunctioncall(){include('b.php');}publicfunctiondo_some_magic(){//magicstuff...}publicstaticfunctionstatic_func(){//somecode...}}文件b.php:do_some_magic();echo'['.$this->a.']';self::static_func();echo'['.self::CONST1.

php - 工厂方法的正确 phpdoc @return

我很好奇如何记录以下场景。想象一组类:abstractclassPersonality{}classMeextendsPersonality{}classMyselfextendsPersonality{}classIreneextendsPersonality{}如果我正在编写工厂式方法来实例化并返回Personality类的子类,我将如何正确记录@return?@returnmixedA"Personality"subclassobject或@returnPersonalityA"Personality"subclassobject 最佳答案

php - PHPDoc 的冗长是否比它的值(value)更麻烦?

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我今天第一次尝试使用PHPDoc,很快就遇到了问题。对于每1行变量声明,我至少有5行注释。示例:/***Holdspaththeremoteserver*@name...*@global...*/$myvar=...当然,返回不错-但这会将10行的配置文件变成60行的文件。我花了很长时间才填满,而且我还不相信它比简单的一行增加了那么多。它还会给我的工作流程带来麻烦。一切都很好,直到我需要进

动态魔术属性(或方法)的 PHPdoc

我最近创建了一个类来创建HTML元素。我没有为每个现有的HTML元素和属性创建一个方法,而是决定使用魔法方法__get和__call。所以用我的代码我基本上可以做到这一点:$signUpForm->insert->input->type('text')->name('firstName')->maxlength(100)->disabled$signUpForm->insert->input->type('email')->name('emailAddress')->maxlength(100)等等但由于我决定保持这种“魔法”和简单,我也可以这样做:$signUpForm->inser

php - 如果我使用 use 导入类,我应该在 PHPDoc 中使用 FQN 吗?

假设我有一个UserController类,我正在使用use导入App\User类。在内部,有一个show()方法接收User的实例。namespaceApp\Http\Controllers;useApp\User;classUserControllerextendsController{/***Showuserinfo**@paramUser$user*@returnIlluminate\Http\JsonResponse*/publicfunctionshow(User$user){//Dosomething...}}是否建议在PHPDoc中添加User的完全限定名称,即使我正在

php - 如何用 PHP 解析 phpDoc 风格的注释 block ?

请考虑以下代码,我试图用它仅解析文件中的第一个phpDoc样式注释(不使用任何其他库)(文件内容放入$data变量用于测试目的):$data="/***@fileAlotofinfoaboutthisfile*Couldevencontinueonthenextline*@authorme@example.com*@version2010-05-01*@tododostuff...*//***Commentbijfunctiebar()*@paramArraymetdingen*/functionbar($baz){echo$baz;}";$data=trim(preg_replace

php - Eclipse 完成 - @var (PHPDoc) 问题

我有一个奇怪的问题。当我在模型加载方法中使用@returnModel\Article时,我会在Eclipse的自动完成中看到模型的方法。模型加载方法返回更多对象,所以我希望它@returnMy\BaseModel然后放入/*@var$modelModel\Article*/具体针对每个模型(当我使用它时)。问题是@returnModel\Article运行良好(我看到Model\Article+My\BaseModel方法)但是其他方式(@returnMy\BaseModel和内联/*...*/)没有-它说'没有可用的完成'.我尝试在$model=...;之前和之后放置内联注释,但都不

php - 如何在 PHPDoc 中记录多个变量声明

我使用短语法来定义类的成员变量,而不是private$a;private$b;private$c;我用private$a,$b,$c;现在我使用PHPDoc像这样告诉IDE每个成员的类型:/**@varclassA*/private$a;/**@varclassB*/private$b;/**@varclassC*/private$c;但是这不适用于短语法:private/**@varclassA*/$a,/**@varclassB*/$b,/**@varclassC*/$c;我做错了什么? 最佳答案 不是你想听到的答案,而是你做不