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参数描述）。

在PHPDoc中抑制类DocBlock错误

1 个答案: