这些注释中的 @ 符号代表什么？

Question

我正在阅读别人编写的PHP代码，该文件中每个方法之前都有注释。注释中的@access和@var是什么意思？

/**
 * EE Superobject
 *
 * @access      private
 * @var         object
 */
private $EE;

非常感谢！

- Vince

---

docblock 标签 - 用于以一种可以生成自动化文档的方式记录类/方法/属性，并可使用 PHPDocumentor 或类似工具进行处理；还可以被 IDE 用于自动完成。 - Mark Baker

Answer 1

这是一些文档生成工具使用的注释，用于生成相应的文档。

- Luchian Grigore

Answer 2

这些标签是phpDocumentor编译文档时使用的。

phpDocumentor标签与Sun Java编程语言的JavaDoc工具的标签非常相似。仅当它们是DocBlock的新行上的第一件事时，才会解析标签。您可以在整个文档中自由使用@字符，只要它不开始新行即可。例如：

/**
 * 标签演示
 * @author 此标记已解析，但此@version标记被忽略
 * @version 1.0 此版本标记已解析
 */

以下是标准标签列表：

@access
@author
@copyright
@deprecated
@example
@ignore
@internal
@link
@see
@since
@tutorial
@version
inline {@internal}}
inline {@inheritdoc}
inline {@link}

- Kermit

---

这不仅适用于PHPDoc，还有许多使用此功能的文档生成器。 - cryptic ツ

Answer 3

这是 PHPDoc 标签: http://en.wikipedia.org/wiki/PHPDoc 它们用于描述类或函数的某些属性；文档是从类/函数上方的注释自动生成的。

- Lâm Tran Duy

---

这不仅适用于PHPDoc，还有许多使用此功能的文档生成器。 - cryptic ツ

@crypticツ 我指的是PHPDoc作为一种格式，而不是一种工具。事实上，这种格式被许多生成器支持，这是一件好事。我想“文档块”可能是一个更合适的名称，但我认为“PHPDoc标签”更明确。 - Lâm Tran Duy