【问题标题】:How to mark that an argument is optional in PHPDoc?如何在 PHPDoc 中标记参数是可选的?
【发布时间】:2010-12-31 09:52:32
【问题描述】:

我有这个带有可选参数的构造函数。主要问题是可用性。使用我的框架的开发人员会立即感到头疼,因为他不知道他是否可以提供论据,什么样的论据,或者他是否根本不能。结论:简直糟透了。但是如果有人安装了像 Netbeans 这样合理的 IDE,PHPDoc 可能会有所帮助;)

所以:

class ChildClass extends ParentClass {
    public function __construct() {
    $tplFile = func_get_arg(0);
    if (!isset($tpl)) {
        $tpl = 'index';
    }
    parent::__construct($tpl);
    }
}

我如何在这里使用 PHPDoc 来表明可以提供一个可选的 [$tpl] 参数?

【问题讨论】:

    标签: php oop phpdoc


    【解决方案1】:

    声明一个参数并给它一个预设:

    public function __construct($my_argument = 0) 
    

    我的 IDE(phpEd,对 phpDoc 敏感)可以正确解释它。 phpDoc 也应该将参数放在大括号中:

    show ([$my_argument])
    

    【讨论】:

    • 通过在代码本身中声明一个可选参数,phpDoc 和原始代码的读者都可以解释该方法可以在没有参数的情况下使用。无论您是否这样做,只需在 docblock 中使用 @param 标记即可为 phpDoc 提供一些可写的内容,而且我知道 Eclipse PDT 至少会在弹出有关悬停方法的文档时将其拾取并显示出来.
    • 有关当您不在函数签名本身中明确指定参数时如何使用 @param 的更多详细信息,请参见 [1] 中的底部示例...。只需想象一下"@param mixed $v,..." 正在使用的行。 [1] -- manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/…
    【解决方案2】:

    您也可以使用reflection class。

    【讨论】:

      猜你喜欢
      • 2012-11-06
      • 2018-08-10
      • 1970-01-01
      • 2014-07-09
      • 2013-01-08
      • 2010-11-26
      • 1970-01-01
      • 1970-01-01
      • 2013-03-03
      相关资源
      最近更新 更多