John Davidson

Message:

Since I'm new and just started to work on the Codeigniter framework I've noticed the @ in the files
ex.

• @package CodeIgniter


• @author EllisLab Dev Team


• @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)


• @copyright Copyright (c) 2014 - 2019, British Columbia Institute of Technology (https://bcit.ca/)


• @license https://opensource.org/licenses/MIT MIT License


• @link https://codeigniter.com


• @since Version 1.0.0

What are those @ followed by the various names. I would like to know those so if by any chance I can use it in future.

---

My Answer:
The @ symbols followed by various names in CodeIgniter framework are PHPDoc annotations. PHPDoc is a documentation generator for PHP code, and these annotations provide additional information about the code to help with documentation generation and code analysis.

Here are some common PHPDoc annotations used in CodeIgniter:

- @package: Specifies the package to which the class or function belongs.
- @author: Specifies the author of the code.
- @copyright: Specifies the copyright information for the code.
- @license: Specifies the license under which the code is distributed.
- @link: Specifies a link to the official website or documentation for the code.
- @since: Specifies the version of the framework in which the code was introduced.

These annotations are not required for the code to function, but they can be helpful for documenting and understanding the codebase. You can use these annotations in your own code to provide additional information for yourself and other developers who may work on the project in the future.