我正在从其他人那里阅读一些 PHP 代码,并且该文件在每个肉类之前都充满了注释。注释@access 和@var 是什么意思?
/**
* EE Superobject
*
* @access private
* @var object
*/
private $EE;
非常感谢 !
它是一些文档生成工具用来生成所述文档的注释。
专门用于phpDocuemntor
编译文档。
phpDocumentor 标记与 Sun 的 Java 编程语言的 JavaDoc 工具的标记非常相似。仅当标签是 DocBlock 新行上的第一件事时,才会解析标签。您可以在整个文档中自由使用 @ 字符,只要它不开始新行即可。一个例子:
/** * 标签演示 * @author 这个标签被解析,但是这个@version 标签被忽略 * @version 1.0 这个版本标签被解析 */以下是标准标签列表:
@使用权 @作者 @版权 @不推荐使用 @例子 @忽视 @内部的 @关联 @看 @自从 @教程 @版本 内联{@internal}} 内联{@inheritdoc} 内联{@link}
这些是 PHPDoc 标签:http://en.wikipedia.org/wiki/PHPDoc它们用于描述类或函数的某些属性;文档是根据类/函数上面的注释自动生成的。