Question

在Symfony we can use PHPDoc注释中，我想知道如何使用Symfony项目在PHPDoc块中引用教程。

在the PHPDoc documentation example中，我们看到他们引用了此文件phpDocumentor/phpDocumentor.pkg：

/**
 * Text with a normal @tutorial tag
 * @tutorial phpDocumentor/phpDocumentor.pkg
 */
function element()
{
}

但是我应该如何以及在哪里将这些文件放在我的Symfony项目中？

我们还应该知道Symfony中使用的@package和@subpackage注释are not。

更新

我想使用tutorial标签粘贴一些关于如何使用该方法的示例：tutorial标签在生成phpDoc时将“链接”文件的内容导入到描述中。我的问题是如何链接到Symfony中的这个文件或者把它放在哪里，在Symfony项目的哪个文件夹中。

Answer 1

Symfony的工作方式与任何PHP框架类似，因此其代码通过PHPDoc进行记录，您在文档链接中指出的更多是Symfony在使用PHPDoc时所做的“例外”。

在PHPDoc中，您可以引用带有@link注释的外部链接，添加到类的doc块，任何documentable element的方法。

示例：

<?php

/**
 * Foo class.
 *
 * @see \ChildFoo 
 * 
 * @link http://helpful_related_resource.com/Foo
 */
class Foo
{
    /**
     * @var Bar
     *
     * @link http://helpful_related_resource.com/Foo#$bar
     */
    private $bar;

    /**
     * Bar method.
     *
     * @link http://helpful_related_resource.com/Foo#getBar() Helpful resource
     * @link http://helpful_related_resource.com/BarFactory   Another helpful resource
     *
     * @return Bar
     */
    public function getBar()
    {
        /** 
         * @link http://helpful_related_resource.com/Baz
         */
        $baz = new Baz();
        $this->bar->addBaz($baz);

        return $this->bar;
    }
}

Symfony3：添加PHPDoc @tutorial标签

1 个答案: