php - 没有行号的 PHPDOC 示例

Question

根据 PHPDocumentor 的文档，要显示一个示例，它将是这样的：

@example [location] [<start-line> [<number-of-lines>] ] [<description>]

如果代码从不更改，这似乎是一个有效的解决方案，但是无论何时您将新代码添加到该位置的任何位置，您的起始行都可能发生变化，这意味着您必须不断更新这些不同的引用。

有没有更好的方法来展示如何在 DocBlock 中使用类方法的示例，而无需引用外部当前使用示例？

这是我的目标：

/**
 * @example This is how you use this method:
 *
 *     $baz = Foo::bar( array('bing' => $bing) ); 
 */

然后它作为示例显示在文档中。有任何想法吗？

score 1 · Accepted Answer

您可以通过“代码”分隔符在文档块本身中显示代码示例。因此，对于您的原始示例：

/**
 * This is how you use this method:
 * <code>
 *     $baz = Foo::bar( array('bing' => $bing) ); 
 * </code>
 */

@example 标记的手册页 [1] 显示了 docblock 中的“代码”部分以及指向单独文件中行的 @example 指针。

1 回答 1