我正在使用 phpCheckstyle phpcheckstyle用于标准化我的代码注释。验证警告中的文件后,它建议 “文档 block 注释应包含有关每个 PHP 文件的文件(@file)的信息” 添加 @file 标记时警告会解决 - 我想知道应该为该标记分配什么值(它表示什么)。
@file 和 @filesource 有什么区别
谢谢
最佳答案
根据代码标准,@file
是一个 Doc-Block
注释(针对每个文件),并且是对该文件用途的描述。
例如,假设您的模型文件 Users.php 及其所有方法,那么您可以在文件注释中添加如下内容:
/**
@file
This file will store all model methods to recover/update/delete Users.php
....
*/
@filesource,afaik,类似于@example标签,你可以看看pear文档here
关于php - 在dockblock中@file标签是什么意思,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/24775949/