Phpdoc没有找到该文件的摘要

Question

我在我们的服务器上安装了phpDoc,设置等等.它正确地生成文档.我们正在使用"响应式"模板,但无论使用何种模板,都会发生此错误.

在"错误"下,扫描的每个文件似乎都有以下错误:

Type        Line    Description
error       0       No summary was found for this file

我已经详尽地搜索了这个,但无法找到解决方案.我甚至已经完成了跟踪消息背后的服务器错误代码PPC:ERR-50000并尝试追踪导致错误的条件的努力,但有点丢失.

我的问题:

这个错误是什么意思？为什么它在第0行,我怎么能摆脱它？!即使我已正确完成docblock,我可以隐藏此错误吗？我没有错误的ocd疯了!

非常感谢

编辑 一些额外的信息:我的每个文件都有来自文件第1行的以下docblock:

<?php 
    /**
     * Short Description
     *
     * Long Description
     *
     * @package      Some Package
     * @subpackage   Some Subpackage
     * @category     Some Category
     * @author       F Bloggs <gbloggs@email.com>
     */
?>

Answer 1

但是文件的顶部是否有两个这样的docblock？第一个docblock应该是文件本身的文件块,第二个docblock应该与它后面出现的第一个可记录代码元素配对.

但是,如果文件顶部只有一个文档块,它将与找到的第一个代码元素配对,因此"文件本身"似乎缺少其文件块.这就是错误应该表明的.

Answer 2

@ashnazg是对的,但我想通过一个例子改进你的答案.

甲文件级文档块应该是第一的docblock和必须有一个摘要(在这个例子中概述" 类分类|芯/ Category.class.php ").然后在类定义之前放置类级DocBlock.

<?php
/**
 * Class Category | core/Category.class.php
 *
 * @package     MyApp XYZ
 * @subpackage  Categories
 * @author      Sandro Miguel Marques <sandromiguel@something.com>
 * @version     v.1.1 (06/12/2016)
 * @copyright   Copyright (c) 2016, Sandro
 */

namespace Myapp;

use \PDO;
use \Exception;
use \PDOException;

/**
 * Class Category - active record
 *
 * Recipe categories
 */
class Category {

    ...