@filesource 标签只可作为文档级文本块(DocBlock)的应用,在其它地方使用此标签都将被忽略。phpDocumentor 解析当前文件的源代码,将其源代码进行语法高亮、添加行号,并且在生成的文档中添加它的链接。
@example 标签的意图与其相似,区别在于 @example 用于解析和创建链接到外部文件。
注意:@filesource 标签只在 PHP 4.3.0 中使用。
应用示例:
<?php
/**
* Contains serveral example classes that I want to parse but I
* also want to show the full source
* @package mypackage
* @subpackage example
* @filesource
*/
/**
* This class does things
* @package mypackage
* @subpackage example
*/
class oneofmany extends mainclass
{
//...
}
?>
参考:http://pear.php.net/package/PhpDocumentor/docs/1.4.3/phpDocumentor/tutorial_tags.filesource.pkg.html