【发布时间】: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