2013-04-11 104 views
3

我正在阅读其他人的一些PHP代码,并且该文件在每个meathod之前填充了注释。 @access和@var是什么意思?这些评论中的@意味着什么?

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

很多谢谢!

+3

docblock标记 - 用于以可以使用PHPDocumentor或类似方法生成自动文档的方式记录类/方法/属性;也可以通过IDE自动完成 – 2013-04-11 22:10:54

回答

1

专门用于phpDocuemntor编译文档。

phpDocumentor的标签非常相似,对于Sun公司的Java编程语言的JavaDoc工具标签。如果标签只是DocBlock新行中的第一行,则只能解析标签。只要不开始新行,您可以在整个文档中自由使用@字符。举个例子:

/** 
* tags demonstration 
* @author this tag is parsed, but this @version tag is ignored 
* @version 1.0 this version tag is parsed 
*/

下面是标准的标签列表:

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

这不是特定于PHPDoc,有许多文档生成器利用这个。 – 2013-04-11 22:31:26

4

它是由一些文档生成工具来生成用于注释说文档。

0

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

+0

这不是PHPDoc所特有的,有许多文档生成器利用它。 – 2013-04-11 22:32:13

+0

@crypticツ我的意思是PHPDoc作为一种格式,而不是一种工具。事实上,这种格式得到众多发电机的支持,这是一件好事。我想“docblocks”将是一个更合适的名称,但我认为“PHPDoc标签”更加明确。 – 2013-04-12 05:50:22