首页 > TAG信息列表 > phpdoc
php-@return标记是否对返回类型声明无效
phpdoc的@return标记对返回类型声明没用吗？换句话说,在这种情况下@return标记有什么好处： /** * Example function. * * @return int */ public function getOne(): int { return 1; } 我们应该在PHP7中删除此注释吗？解决方法: Should we remove this annotation in PHP7?如何创建phpdoc教程/扩展页面以补充注释的代码
我正在尽一切努力获取phpdocumentor,以允许我使用DocBook教程格式来补充它创建的文档： >我正在使用Eclipse >我已经在OSX机器上通过PEAR安装了phpDocumentor>我可以从我的php类运行并自动生成代码>它不会格式化教程-我找不到解决方案 我尝试将.pkg示例文件移动到整个文件结构中,并在PHP中的软件包的文档？
因此,在PayPal文件夹中,我拥有使用其API的多个类. 我想制作一个文档,说明如何按顺序使用所有类.所以这是我的问题： >如何为他们创建一个包裹？导致以上每个类,我使用了phpdoc标签@package PayPal.是一个在PHP包只是一个文件夹？ >我将包装文件放在哪里？有最佳做法吗？名为…的文件夹中的文PHPDoc-如何在PHP中标记构造函数
在JSDoc中,我可以用@constructor标记我的构造函数. 现在,我试图在PHPDoc规范中找到如何对PHP构造函数执行相同的操作,但是它们从未提及任何类似的内容.在PHP中标记构造函数的正确方法是什么？ 这个： /** * @constructor */ public function __construct() { } 似乎无效.解决方法:如何设置PhpStorm识别变量的类
我在PhpStorm中遇到了一个问题.我有一个代码： /** * $this->data['rows'] My_Class[] */ public function countRows(){ foreach($this->data['rows'] as $row){ $row->(here i want to get all functions in a class with autocomplete) } }PhpStorm：如何分辨数组成员的var类型？
我使用PhpStorm 2016.2.1 IDE.我有一个类型化的数组(所有成员都属于同一类,已知的类),我希望IDE知道该类型,以便它可以帮助我完成自动完成/智能化. class MyClass{ /** * @var array */ public $userArray; public addUser($uid){ $this->$userArray[在PHP中模拟通用类
我正在尝试实现处理查询的Results类.简而言之,您将具有以下功能： function all(); function first(); function paginate(int $perPage, int $pageNo = 1); 这很好用,问题是当在多个不同的查询类中使用相同的结果类时,IDE无法知道返回类型.例： UserQuery-> results()-> all()将返回通过PHPdoc继承抽象方法的返回类型变窄导致PHP错误
假设我们在PHP中具有以下继承链 abstract class Entity {} abstract class RealEntity extends Entity {} abstract class PseudoEntity extends Entity {} 以及一堆镜像相同继承链的其他类 abstract class EntitySerializer { /** * @return Entity */ abstract publ如何在PhpStorm 9中为Blade模板自动完成变量？
我想在刀片模板中考虑PHPdoc块. PhpStorm 9,Laravel 5.1,刀片模板文件： <?php /* @var App\Models\User $user */ ?> ... <?= $user->email ?> <- autocomplete for the word "email" is working ... {{ $user->email }} <- autocomplete not working 我尝php – 我应该使用@return self,this还是当前的类？
我有一个返回当前对象的方法,我该如何记录？ /** * set something * * @return this */ public function setSomething(){ // ... return $this; } 或者我应该@return self或@return Current_Class_Name？ 这个问题不是“主要基于意见”(并且应该重新开放)的原因PHP：调用变量函数名(函数指针);如何告诉IDE我的函数被调用？
我目前正在尝试删除我的项目中的所有错误和警告,我的PHPStorm中的检查工具给了我. 我遇到一个片段PHPStorm说“未使用的私有方法_xxx”虽然它实际上使用,但以动态的方式.这是一个简化的代码段： <?php class A { private function _iAmUsed() { //Do Stuff... }PhpStorm – 参数的PHPDoc“任何”类型
我来自一种严格类型的编程语言,它有一个名为“ANY”的类型. 因为PHP是松散耦合的,我需要对我的PhpDoc进行某种类型的提示,说变量,参数或返回值可以是任何类型.目前我必须写下这样的东西： @var string | int | bool | array | object $someVariable 它会让我的生活更轻松,如果我可以eclipse PDT中的错误phpdoc错误
我目前使用Eclipse Photon PDT作为旧的PHP应用程序.在这个应用程序中有很多phpdoc注释,但其中一些被标记为错误. > for“@param unknown $form”=> “未知无法解析为一种类型”. >同意“@return Ambigous< multitype：string,multitype：>” => “Ambigous无法解析为一种类型”. 有人将PHPdoc包含在CakePHP .ctp文件中
我正在使用PHPdocumentor记录我的CakePHP应用程序.您可能知道,在CakePHP约定之后,视图包含在.ctp文件中(例如app / views / addresses / index.ctp),它们基本上是普通的PHP文件,只是改变了文件扩展名. PHPdocumentor只识别.php文件,我在配置文件中找不到一个选项让它知道.ctp文件.是否可以为PHPDoc的调用方指定参数的显式类型
有一个方法调用表达式： $session->setUser($this->em->getReference(UserAccount::class, $ownerId)); 其中setUser声明为 public function setUser(UserAccount $user): self $this-> em-> getReference是Doctrines的实体管理器方法返回对象| null. 因此,PhpStorm将此调用标记PhpStorm类型提示派生类返回值
是否有可能提示PhpStorm在下面的代码中返回item()方法的值具有类型DOMElement(没有修改实际的PHP语句,即通过某些外部设置的PhpStorm或插件或使用某种类型的PHPDoc注释等) ？ 同样,请不要建议我修改代码中的语句,特别是部分$list-> item(0) – > getAttribute(‘test’). 另外,我发现PHPDoc对@ property-read和@ property-write的解释
我认为这个问题的标题很清楚.我需要解释@ property-read和@ property-write.这是关于phpDoc http://manual.phpdoc.org/HTMLframesConverter/default/的链接,但在那里我找不到关于它的解释.只有@property的解释解决方法:关于魔法属性的Here’s a good explanation. 基本上,@ properphp – 记录隐式输入参数,例如$_SESSION
如果一个函数依赖于$_SESSION [‘some_var’],那么标题会注释掉以清除它.你怎么做呢？就像文字一样,还是什么？ 甚至@param？解决方法:您可以使用@uses来记录超级全局使用PEAR安装phpDocumentor
在http://www.phpdoc.org/,http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quickstart.pkg.html和https://github.com/phpDocumentor/phpDocumentor2的主页上,安装phpDocumentor的说明如下： pear channel-discover pear.phpdoc.org pea如何在PHPDoc中记录多个变量声明
我使用短语法来定义类的成员变量,而不是 private $a; private $b; private $c; 我用 private $a, $b, $c; 现在我使用PHPDoc告诉IDE每个成员的类型如下： /** @var classA */ private $a; /** @var classB */ private $b; /** @var classC */ private $c; 但是这不如何在Eclipse中使用PHPdoc
我们目前正处于一个新项目的开始阶段,并且希望(从一开始)尽可能多地评论从一开始就帮助未来的发展. 我试图找出在Eclipse中使用phpDoc的最佳实践,但结果非常简洁. 您能否分享使用phpDoc在Eclipse中评论内容的最佳实践和技巧？解决方法:关于应该评论什么以及如何评论没有“真正的标准phpDocumentor：仅限文档类
我正在尝试了解phpDocumentor.我通常每个文件都有一个classe.我被迫记录文件和课程吗？我想记录课程(我为什么要记录文件？)但我收到警告…… WARNING in comment.class.php on line 8: DocBlock would be page-level, but precedes class "Comment", use another DocBlock to documen对于itteratable对象有适当的phpdoc评论吗？
我在尝试为以下代码示例获取正确的自动完成时遇到了一些问题.我在Win7机器上使用PHPStorm 7. 首先只是一个简单的课程. /** * Class myObject */ class myObject { /** * some method */ public function myMethod() { // do something } }phpDocumentor不会覆盖父类的文档
所以,基本上我有以下设置： class A { /** * This is some documentation */ public function foo() {} } class B extends A { /** * This documentation is way more specific than in class A */ public function foo() {} } 当我尝试如何作为参数传递PHPDoc匿名函数？
当它作为参数传递时,我应该如何记录匿名函数？例如： // Call my_function(), passing 2 arguments. my_function( 'foo', function() { // Body of the anon function I'd like to document. } ); 提前致谢.解决方法:要记录函数接受Closure,我建议callable： /** * Do something