在PHP中,我注意到人们在源代码注释中添加了“@”符号。一个很好的例子是任何WordPress。当您查看源代码时,您会看到类似
的内容/** Results of the last query made
*
* @since 1.0.0
* @access private
* @var array|null
*/
var $last_result
(wp-db.php,第124行)
它改变了我的编辑器中的语法高亮,所以我假设它做了一些事情,但我不确定它做了什么。有人会解释评论中“@”符号的作用吗?
答案 0 :(得分:7)
这些是PHPDoc
条评论。它们旨在通过机器解析来支持自动化文档和IDE代码完成。
答案 1 :(得分:3)
前面的答案是正确的,说明源注释中的@符号是PHPDoc注释。它们还可以用于称为“注释”的东西,它将元数据添加到代码的某些元素并且可以影响应用程序的行为。它在PHP中没有得到官方支持,但它已经讨论了好几年,并且正在Symfony,Doctrine和其他项目中使用。
通过幻灯片(与我没有任何关系)对PHP和注释的所有内容进行的出色解释:
http://www.slideshare.net/rdohms/annotations-in-php-they-exist
关于注释主题的一般性讨论:
http://en.wikipedia.org/wiki/Annotation
2010年关于在PHP中实现注释的RFC:
答案 2 :(得分:0)
此类表示法用作从注释中创建文档解析器的方法。因此,第一个@可以被识别为版本,第二个可以被识别为参数等等。
答案 3 :(得分:0)
这通常用于从源代码文件自动生成文档。在这种情况下,@ _ 用于标识有关变量的元数据。 @var可以告诉文档解析器以下文本描述变量,而不是按顺序进行评估。