Question

我已经安装了phpDocumentor 2，并希望在生成的文档中包含每个方法的源代码。但是，我注意到内联@source标记似乎没有被选中，并且似乎只在phpDocumentor 1's documentation中引用它。

以下是我一直在尝试的内容：

/**
 * Test Comment
 *
 * {@source}
 */
public function test_method() {
    echo('Hi!');
}

我希望将{@source}替换为以下HTML：

<code>
    echo('Hi!');
</code>

这现在已被弃用吗？如果是这样，有没有办法用phpDocumentor 2来实现这个目标？

Answer 1

我今天对此进行了正确的研究，并在phpDocumentor邮件列表上与Mike van Riel进行了交谈。

简单地说 - 你不能完全按照我的意思去做。

PHPDocumentor 2的默认模板'responsive'不支持动态显示代码。你可以做的是切换到另一个模板，'new-black'，它将显示相应文件的源代码。这适用于@filesource标记，并且在构建文档时会有一个--sourcecode开关，该文档会自动为所有文件启用此功能。

但是，无法做的是在方法级别包含代码，这是@source标记的用途。这根本就不受支持，原始structure.xml文件甚至不存储这些信息。

话虽如此，迈克已经说过“我绝对想要这个功能” - 所以这里希望它能够包含在未来！我没有时间这一秒，但我会在GitHub上将其作为一个问题提交。如果您也热衷于使用此功能，请make it known。