有没有办法抑制 get 和 set 方法的 "no summary"

Question

在记录 php class 时，每个属性的 php 文档具有 get 和 set 方法的命名良好的属性生成的错误报告充满错误，例如：

No summary for method getFirstName()
No summary for method 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 中的现有标签之一来避免 "no summary" 出现在错误报告中？我无法让 @inheritdoc 工作，因为这些方法没有覆盖其基础 class 中的任何内容，或者在某些情况下没有基础 class.

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

如果不是，记录这样 class 的 DRY 方法是什么？

Answer 1

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

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

如果您希望全局禁用它，那么您实际上是在说 "I don't care about summary warnings, no matter if it's accessor methods or not"...在这种情况下，您无论如何都会忽略所有这些警告。

有没有办法抑制 get 和 set 方法的 "no summary"

Is there a way to suppress "no summary" for get and set methods

php

phpdoc

phpdocumentor2