phpdoc专题提供phpdoc的最新资讯内容,帮你更好的了解phpdoc。
我基本上是PEAR(和PhpDocumentor)的新手;我使用PEAR CLI安装了PhpDocumentor,一切似乎都很好……直到我去使用它,此时我收到以下错误: Warning: require(PhpDocumentor/phpDocumentor/phpdoc.inc): failed to open stream: No such file or directory in /us
以下哪项是为phpDocumentor记录此方法的返回类型的正确方法? 方法1: /** * @return array Foo array. */ public function foo() { return array(1, 2, 3); } 方法2: /** * @return integer[] Foo array. */ public function foo() {
什么是记录其值预期为预定义常量的函数或方法参数的推荐方法?到目前为止,我使用常量的数据类型,稍后我会添加一些解释. 例如.: <?php class Foo{ const METHOD_GET = 'get'; const METHOD_POST = 'post'; /** * Load a new foo * * @param strin
有没有正确或标准的方法来做到这一点? 例如: AbstractFoo.php: abstract class AbstractFoo { /** * Does the phpdoc go here? */ public function fooFunction(); } Foo.php: class Foo extends AbstractFoo { /
是否有用于记录功能的语法,该函数采用单个配置数组,而不是单个参数? 我正在考虑使用类似于以下机制的CodeIgniter样式库: <?php // // Library definition // class MyLibrary { var $foo; var $bar; var $baz; // ... and many more vars... /* Followi
我正在尝试删除我的项目中的所有错误和警告,我的 PHPStorm给我的检查工具. 我遇到一个代码段PHPStorm说“未使用的私有方法_xxx”,而实际使用,但是以动态的方式.这是一个简化的片段: <?php class A { private function _iAmUsed() { //Do Stuff... } public functio
我正在使用 Eclipse PDT开发.我一直在我的代码中添加phpdoc评论, 但实际上从来没有在Eclipse中生成结果文档.我应该怎么做 – Eclipse中有一些功能,还是应该在外部完成文档生成? 要生成文档,您应该使用 phpDocumentor,它可以作为PEAR包安装. 那么你必须从命令行调用它;实际上,我从未见过Eclipse PDT. 一个很好的解决方案是建立一个连续集成的平台(
我不明白为什么PhpStorm给了我以下警告 PHPDoc注释与这种方法不匹配函数或方法签名: /** * Create a new instance of the class * @param string $classname Class to instantiate * @return object the instance * @throw FactoryException If
我在 PHP代码中使用@since注释.我有一个关于它的使用的问题.说我有一个执行特定任务的功能,它已经在版本1.0中实现了. 所以我目前有@since 1.0. 现在我继续改变函数的名字,虽然内部的代码保持不变. 现在应该说@since 3.0(当前版本)还是保持@since 1.0? 函数名不存在于1.0,所以@since应该是3.0.不同名称的功能在旧版本中提供相同的功能是无关紧要的您将无法
好的,我有这个phpdoc上面的我的类方法 /** * this a function that translates the text * @param string|boolean $lang if string the string given in the parameter will be the language code that will represent the langu
我有这样的多重继承: Can I extend a class using more than 1 class in PHP?(我们不要讨论这种方法)并希望我的IDE了解继承的类方法和属性.有没有办法用PhpDoc做到这一点? 似乎目前没有办法轻易做到.我在PhpStorm问题跟踪器上创建了一张票.也许他们会增加对此功能的支持. http://youtrack.jetbrains.net/issu
我有一个用Cake PHP编写的 PHP REST API作为项目的一部分.所有API端点都作为控制器中的单个方法存在,并接受参数并在JSON字符串中返回值.我试图想象我应该如何记录这些方法phpDocumentor2的参数和返回类型. 例如,如果我在UsersController中有一个edit()方法,它更新User模型的指定字段,其骨架如下所示(为简洁起见,我简化了代码): public f
是否可以链接到另一个方法/类/属性/等.在我的项目内部@deprecated标签内联?像这样: /** * Method description * @deprecated 1.0 Reason for deprecation, use {@link newMethod()} instead! * @param string $str * @param string|null $str2
如何表明该方法是 PHPDoc接口的一部分? 例如: /** * @implements BarInterface */ class Foo implements BarInterface { /** * @thisMethodIsHereBecauseItIsAPartOf("BarInterface") */ public function doBar(
下面小编就为大家带来一篇完美解决phpdoc导出文档中@package的warning及Error的错误。小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧