docblock中的@file标记是什么意思

Question

我正在使用phpCheckstyle phpcheckstyle来标准化我的代码评论。在警告中验证文件后，它建议 “Doc块注释应该包含有关每个PHP文件的文件（@file）的信息” 添加@file标记时警告会解决 - 我想知道我应该为此标记分配什么值（它表示的内容）。

@file和@filesource

之间有什么区别

谢谢，

Answer 1

根据代码标准@file是Doc-Block注释（针对每个文件），并且是对此文件的用途的描述。

例如，想象你的模型文件Users.php及其所有方法，你可以在文件中添加如下内容：

/**
 @file
   This file will store all model methods to recover/update/delete Users.php
 ....
*/

@filesource，afaik，类似于@example标记，您可以查看梨文档here