0

当使用具有良好命名属性的 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 中的现有标签之一来避免错误报告中出现“无摘要”？我无法开始@inheritdoc工作，因为这些方法没有覆盖其基类中的任何内容，或者在某些情况下将没有基类。

我查看了docblock 模板 /**#@+和/**#@-*/标签，但无法让它们在一组封闭的方法中应用摘要。我只尝试了简短的摘要，也尝试了长摘要。

如果不是这样记录类的干方法是什么？

4

1 回答 1

1

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

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

如果您希望全局禁用它，那么您实际上是在说“我不关心摘要警告，无论它是否是访问器方法”......在这种情况下，您无论如何都会忽略所有这些警告。

于 2018-05-18T08:56:13.170 回答