phpdocumentor @example行数

时间:2017-03-14 09:14:02

标签: phpdoc phpdocumentor2

我想知道如何使用它。 我试图用这个: https://www.phpdoc.org/docs/latest/references/phpdoc/tags/example.html

我这样使用它:

/**
  * Format date/timestamp to localized format
  *
  * @example site/modules/KeyAgencyGeneral/Helper/Page.php 247 16 my description
  */

起始线确实有效,但线条数量没有,它会作为说明的一部分显示。

在文档中,它说要像这样使用它:

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

当我尝试使用括号时,它根本不起作用,所以我不知道如何限制显示的行数。

(附带问题:是否可以在示例中启用突出显示,或显示行号?)

1 个答案:

答案 0 :(得分:0)

在:

>php bin\phpDocumentor.phar -V
phpDocumentor version v2.8.5

效果很好:))

例如:

/**
 * configure the system
 * @example BillingCommand.php  98 3 some Date methods
 */
protected function configure()
{
...........

你有98行的三行:

enter image description here

(phpDocumentor在源文件的文件夹中找到示例)

要在示例中启用突出显示或显示行号,您必须编辑用于呈现文档的模板。复制并修改一个......