php - 在dockblock中@file标签是什么意思

标签 php comments

我正在使用 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/

相关文章:

php - 如何在 php 中使用随机记录创建分页但保持以前的状态

css - 如何在 CSS 中将多行注释包裹在另一个注释中?

javascript - 带有评论框的粘性页脚,如 WhatsApp

javascript - 通过使用 Select2 插件中的匹配器功能,不会出现未找到结果消息

php - Magento : confirm, 进入类别前

javascript - 使用jquery将php数组发送到外部页面

c++ - 生成注释以解释 C++ 程序的结构

更新 MySQL 表的 PHP 代码

printing - 在 Visual Studio 中插入一行注释

emacs - 如何禁用 Emacs 自动向右移动命令?