【问题标题】:PHPDoc - how to mark constructor function in PHPPHPDoc - 如何在 PHP 中标记构造函数
【发布时间】:2014-07-09 18:37:45
【问题描述】:

在 JSDoc 中,我可以用 @constructor 标记我的构造函数。 现在我试图在 PHPDoc 规范中找到如何为 PHP 构造函数做同样的事情,但他们从来没有提到任何类似的东西。在 PHP 中标记我的构造函数的正确方法是什么。

这个:

/**
 * @constructor
 */
public function __construct()
{

}

好像无效。

【问题讨论】:

  • 为什么要标记构造函数?!
  • 嗯,也许只是想在这里过于整洁?这样做没有正当理由(我现在想不出)吗?
  • 构造函数不是作为普通方法调用的,一旦你做了$obj = new Class,你就会调用它,所以你可能想把cmets放在类而不是构造函数上?对于构造函数,您只能指定参数(如果有)。如果没有 - 只是不要发表评论。并且没有返回类型
  • 我同意,构造函数主要是自我记录它所做的事情(即它创建实例),因此必须重新迭代它是多余的。我通常会记录默认属性和状态之外的任何副作用或其他处理。我确实觉得在键入 new Class() 时,大多数 IDE 的代码辅助中没有显示类级别的文档块,这让您感觉像在构造函数上编写类文档(错误地!)。

标签: php constructor annotations markup phpdoc


【解决方案1】:

PHP 文档生成器会将__construct() 方法识别为构造函数。不需要特殊标签。

【讨论】:

  • 需要一些构造函数标签,因为可能存在静态构造函数方法,以便为同一个类封装不同的创建意图。
  • @jhvaras,是否意味着将充当工厂的非构造函数方法,每个都调用实际的真正构造函数? PHP 本身不具备多个构造函数的能力,因此只有通过工厂模式才能模拟多个创建路径。在那种情况下,如果我试图突出它们作为工厂的作用,我可能会在这些非构造方法的文档块中添加@see __construct()。大概你也会将真正的构造函数设为私有/受保护,这样只有工厂才能将对象返回给调用者?
  • 这正是重点。如果您在不同的方法/上下文中需要多个构造函数,您可以私有 __construct() 方法并添加公共静态工厂方法,通常使用不同的参数。这将上下文解耦并隐藏了创建的复杂性。所以一个特殊的标签会很有用。
猜你喜欢
  • 1970-01-01
  • 2017-05-15
  • 2010-12-31
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2019-04-28
  • 2018-09-03
相关资源
最近更新 更多