php dockblock中的@file标记是什么意思

gajydyqb  于 2022-12-21  发布在  PHP
关注(0)|答案(2)|浏览(146)

我正在使用phpCheckstyle phpcheckstyle来标准化代码注解。在验证警告中的文件后,它建议"Doc块注解应该包括每个PHP文件的文件(@file)信息"添加@file标记时,警告解决了--我想知道我应该给这个标记赋什么值(它表示什么)。
那么@file和@filesource之间的区别是什么
谢谢你,

jhkqcmku

jhkqcmku1#

根据代码标准,@file是一个Doc-Block注解(针对每个文件),是对该文件用途的描述。
例如,想象一下你的模型文件Users.php及其所有方法,你可以在文件注解中输入如下内容:

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

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

x8diyxa7

x8diyxa72#

@file不是recognized tag
具有讽刺意味的是,很难找到和浏览关于这个主题的文档。
但是https://pear.php.net/package/PhpDocumentor/docs/latest/phpDocumentor/tutorial_tags.pkg.html建议文件的DocBlock应该是文件中的第一个DocBlock:
举个例子:

1. /**
2.  * tags demonstration
3.  * @author this tag is parsed, but this @version tag is ignored
4.  * @version 1.0 this version tag is parsed
5.  */

......并且没有必要专门对其进行注解。

相关问题