有没有办法抑制获取和设置方法的"无摘要"

Question

当记录一个具有正确命名属性的 php 类时，该属性具有每个属性的get和set方法时，phpdoc 生成的错误报告充满了以下错误：

方法没有摘要 getFirstName((没有摘要 方法集FirstName((

对于每个属性。我正在使用默认模板。如果已记录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 模板/**#@+和/**#@-*/标签，但无法让它们在一组封闭的方法中应用摘要。我只尝试了简短的摘要和长摘要。

如果不是，那么记录此类类的 DRY 方法是什么？

Answer 1

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

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

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