php - 你能在 phpDocumentor 2 中自动将方法的代码放入它的 DockBlock 中吗？

Question

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

这是我一直在尝试的：

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

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

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

现在已经弃用了吗？如果是这样，有没有办法使用 phpDocumentor 2 来实现这一点？

score 1 · Accepted Answer

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

简单地说——你不能完全按照我的要求去做。

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

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

话虽如此，迈克已经说过“我绝对想要这个功能” - 所以希望它在未来被包括在内！我现在没有时间，但我会在 GitHub 上将其作为问题提交。如果您也热衷于拥有此功能，请公开它。

1 回答 1