Question

当记录具有命名良好的属性的php类时，每个属性都有get和set方法，phpdoc生成的错误报告充满了错误，如：

没有方法getFirstName（）的摘要方法setFirstName（）
没有摘要

每个属性。我使用默认模板。如果已记录firstName：

/** @var string $firstName contact's first name */
protected $firstName;

为get和set方法提供摘要感觉多余。

/**
 * @return string
 */
public function getFirstName()
{
    return $this->firstName;
}

/**
 * @param string $firstName
 */
public function setFirstName($firstName)
{
    $this->firstName = $firstName;
}

有没有办法使用phpDocumentor中的一个现有标签来避免＆＃34;没有摘要＆＃34;出现在错误报告中？我无法让@inheritdoc工作，因为这些方法不会覆盖基类中的任何内容，或者在某些情况下不会有基类。

我查看了docblock templates /**#@+和/**#@-*/标记，但无法让他们在一组封闭的方法中应用摘要。我尝试了简短的总结和一个很长的总结。

如果不是以什么方式记录这样的课程？

Answer 1

不，目前没有办法压制它。

由于您可能不想要全局执行此操作，因此可能需要通过注释在每个文档块上完成控制此类功能。所以每个docblock都会得到一些东西......无论是摘要还是注释。

如果你想在全球范围内禁用它，那么你实际上是在说“我不关心摘要警告，无论它是否是访问方法”......在这种情况下，你只会忽略所有这些警告反正。

有没有办法压制＆＃34;没有摘要＆＃34; for get和set methods

1 个答案: