抑制 PHPDoc 中的类 DocBlock 错误

Question

有什么方法可以抑制 PHPDoc 中特定类型的错误，或者指示它不检查某些元素？

我不需要文件和类的 DocBlock。我的典型布局如下：

<?php 
/**
 * Registration service
 *
 * Coordinates the registration actions for users.  These are ...
 *
 * @version a.4.2
 * @author My Name <me at example.com>
 */

namespace MyProject\Service;

use Other\Namespace;

class Registration extends AbstractService
{
    // ...

在这种情况下，PHPDoc 抱怨我没有课程摘要。我可以通过复制 DocBlock 并将其粘贴到类声明上方来解决此问题，但我希望有更好的解决方案。

Answer 1

如果我没记错的话，并且我没有对此进行测试，您可以这样做：

<?php

namespace MyProject\Service;

use Other\Namespace;

/**
 * Registration service
 *
 * Coordinates the registration actions for users.  These are ...
 *
 * @version a.4.2
 * @author My Name <me at example.com>
 */
class Registration extends AbstractService
{
    // ...

现在至少应该将 docblock 识别为类 doc 而不是文件 doc，这在此特定示例中更准确。

要尝试回答您的原始问题，实际上是抑制错误，您可以尝试this answer（它描述了使用命令行--packageoutput 参数）。