CodeIgniter框架中@开头的文件标记含义及使用方法咨询

Hey there! 作为刚接触CodeIgniter的新手，能留意到这些@开头的标记，说明你观察得超仔细😉

这些是PHPDoc注释标签，是PHP圈子里通用的代码文档规范。CodeIgniter作为老牌PHP框架，一直跟着这个规范走，用这些标签标注代码的元信息——既能让开发者快速看懂代码的归属、版权、功能背景，还能通过工具自动生成规整的API文档。

下面逐个拆解你看到的这些标签：

• @package：用来标记代码所属的包/模块，比如@package CodeIgniter就说明这段代码属于CodeIgniter的核心包，方便在大型项目里归类管理代码结构。
• @author：标注这段代码的原始作者或开发团队，像@author EllisLab Dev Team就是告诉你，最初是EllisLab的开发团队写的这段代码。
• @copyright：明确代码的版权归属。你看到的两个不同时间段的版权，是因为CodeIgniter后来换了维护主体——从EllisLab转到了不列颠哥伦比亚理工学院，所以版权信息也跟着更新，把不同阶段的版权归属说清楚了。
• @license：标注代码的开源许可协议。这里的MIT License是非常宽松的开源协议，允许你自由使用、修改、分发代码，只要保留版权声明就行。
• @link：一般用来指向项目官网、相关文档或者关联资源，方便开发者快速找到官方信息。
• @since：标记这段代码（或某个功能）是从框架的哪个版本开始引入的，比如@since Version 1.0.0就说明这个功能从CodeIgniter 1.0版本就存在了。

当你自己开发CodeIgniter扩展、自定义库，甚至修改核心代码时，跟着PHPDoc规范加这些标签，会让你的代码更专业，也方便其他开发者（包括未来的自己）理解：

1. 自定义类/函数时：在类或函数的上方添加PHPDoc注释，举个例子：

/**
 * 自定义用户信息处理类
 * @package MyApp\Libraries
 * @author 你的名字
 * @copyright Copyright (c) 2024, 你的名字/团队
 * @license MIT License
 * @since Version 1.0.0
 */
class UserHandler {
    // 你的类代码
}

2. 自动生成API文档：用phpDocumentor这类工具扫描你的代码，就能自动生成结构化的API文档，不用手动写文档，省超多时间。
3. 团队协作更顺畅：团队里的小伙伴能通过这些标签快速搞懂代码的归属、许可和版本背景，既避免版权纠纷，也能快速定位功能的引入版本，协作效率拉满。

内容的提问来源于stack exchange，提问作者pranavDCpatil