标签: phpdoc

有没有办法为Eclipse PDT添加自定义phpdoc注释？例如,我想@depends在自动完成列表中看到(对于PHPUnit)注释,但现在我只能看到标准注释(例如@deprecated).

提前致谢.

我想知道如何将@pa​​ckage和@subpackage用于类doc.

假设我有以下课程

class My_Controller_Action_Helper_MyHelperAction extends Foo_Bar {}

应该是:

@category    My
@package     Controller
@subpackage  Action_Helper

要么

@category    My
@package     Controller
@subpackage  Action_Helper_MyHelperAction

要么

@category    My
@package     Controller_Action
@subpackage  MyHelperAction

要么

@category   My
@package    My_Controller_Action
@subpackage MyHelperAction

如果使用命名空间而不是'_'怎么办？

如何表明该方法是PHPDoc接口的一部分？

例如:

/**
 * @implements BarInterface
 */
class Foo implements BarInterface
{
    /**
     * @thisMethodIsHereBecauseItIsAPartOf("BarInterface")
     */
    public function doBar()
    {
    }
}

有什么适合替换@thisMethodIsHereBecauseItIsAPartOf("BarInterface")吗？

我有一个带有一些属性的stdClass实例.在PHPDoc中声明这些属性的正确方法是什么？我试过这个,但似乎不行:

    /** 
     * @var $requestParams stdClass
     * @property string cancelUrl 
     */
    $requestParams = $someObj->getSomething();

我刚刚安装了phpdocumentor,但收到了奇怪的错误.我终于找到了问题所在.

Phpdocumentor创建了各种文件,例如someFile.php.txt,它包含PHP代码,但不打算进行解析.事实证明,我的服务器正在解析它们.我还测试了一个名为someFile.txt的文件名,但它没有被解析.

如何防止PHP服务器解析someFile.php.txt等文件？

我的服务器是PHP版本5.4.20,Apache 2.2.15和CentOS 6.4.我的/etc/httpd/conf.d/php.conf文件如下:

#
# PHP is an HTML-embedded scripting language which attempts to make it
# easy for developers to write dynamically generated webpages.
#
<IfModule prefork.c>
  LoadModule php5_module modules/libphp5.so
</IfModule>
<IfModule worker.c>
  LoadModule php5_module modules/libphp5-zts.so
</IfModule>

#
# Cause the PHP interpreter to handle files with a .php extension.
#
AddHandler php5-script .php
AddType text/html .php

#
# Add index.php to the list of files that will be served as directory
# indexes. …

这真的是一个新手问题.

我正在尝试用PHP提高我的技能,所以我正在阅读一些库的代码.我注意到很多PHPdoc标题(这是正确的名称吗？我的意思是:

 /**
 * @param  $config
 * @return bool
 * @author developer1
 */

)包含@author标记.

假设developer2对developer1的函数进行了大量更改,然后提交给github.developer2应该更新@author标签吗？

常见的做法是什么？

PHPDoc提供了@var标记,它甚至可以用于在类之外声明的变量.

但是,如果我将变量定义为对象的魔术成员,这似乎不起作用:

/** @var $app->translator \Fortress\MessageTranslator */
$app->translator = new \Fortress\MessageTranslator();

哪里$app是修身,支持通过神奇的getter和setter方法任意财产分配对象.

我知道我可以Slim通过@property标签将它添加到自身,但是Slim每次创建新属性时我都需要更改核心代码.

PHPDoc是否支持这种动态属性记录？

有没有正确或标准的方法来做到这一点？

例如:

AbstractFoo.php:

abstract class AbstractFoo {
    /**
     * Does the phpdoc go here?
     */
    public function fooFunction();
}

Foo.php:

class Foo extends AbstractFoo {
    /**
     * Or does the phpdoc go here?
     */
    public function fooFunction(){
        // some implementation
    }
}

请考虑以下问题:

• 如果你把PHPDoc的在抽象FooFunction(),并控制+单击$foo->FooFunction(),您将在结束Foo类的FooFunction(),这是没有证件,并不会立即明显的,它的实现的抽象功能.如果很明显,没有简单的方法可以在抽象函数中找到phpdoc

  • 确定对象是什么类
  • 找到它继承的抽象类
  • 对该抽象类中的函数名称执行"查找"

• 如果你只将phpdoc放在子函数中,那么你就会面临在n个继承类的子函数中复制phpdoc.

• 如果你把phpdoc放在两者中,那么抽象函数的phpdoc就变得没用了,除非子类没有phpdoc,想要继承抽象的phpdoc.但即使在这种情况下,也没有简单的方法可以导航到那个抽象的phpdoc.

可能重复:
是否有记录GET/POST参数的标准？

试图找出以有意义的方式通过phpdoc记录请求参数的最佳方法.具体来说,我有一些Zend Framework控制器动作通过GET/POST接收参数,但不是功能参数.这有意义吗？

/**
 * Display a pagination/grid list of rows.
 *
 * @param string $_GET['order']  What field to sort on
 * @param string $_GET['dir']    Direction to sort; either ASC|DESC
 * 
 * @return void
 */
public function listAction()
{
    $order = $this->_request->order;
    ...

如果我为此方法生成了文档,则不会指示"order"和"dir"可以通过url字符串传递给此方法.这样做会更有意义吗？

@param string $order

我应该使用@var吗？

欢迎思考.

我有一个Abc方法类(正文并不重要):

/**
 * @return SomeBaseClass
 */
function getAll() { ... }

在Abc被调用的子类中,AbcChild我想重新定义返回类的类型,以便在Netbeans中正确地看到它.我可以不重新定义方法吗？

/**
 * @return SomeClass
 */
function getAll() { return parent::getAll(); }