我已经安装了phpDocumentor 2,并希望在生成的文档中包含每个方法的源代码。但是,我注意到内联@source
标签似乎没有被拾取,并且似乎只在phpDocumentor 1的文档中引用了它。
这是我一直在尝试的:
/**
* Test Comment
*
* {@source}
*/
public function test_method() {
echo('Hi!');
}
我希望{@source}
能被以下HTML取代:
<code>
echo('Hi!');
</code>
现在是否已弃用?如果是这样,有没有办法使用 phpDocumentor 2 来实现这一点?
我今天对此进行了适当的研究,并在phpDocumentor邮件列表中与Mike van Riel进行了交谈。
简单地说 - 你不能完全按照我所追求的去做。
PHPDocumentor 2 的默认模板"响应式"不支持动态显示代码。您可以做的是切换到备用模板"new-black",这将向您显示相应文件的源代码。这适用于 @filesource
标签,并且在构建文档时有一个--sourcecode
开关,该开关将自动为所有文件启用此功能。
但是,您不能做的是在方法级别包含代码,这就是 @source
标记的用途。这根本不受支持,原始structure.xml
文件甚至不存储此信息。
话虽如此,迈克说"我绝对想要这个功能"——所以希望它在未来被包括在内!我这一秒没有时间,但我会把它作为一个问题提交到 GitHub 上。如果您也热衷于使用此功能,请告知它。