Symfony3：添加 PHPDoc @tutorial 标签答案

【问题标题】：Symfony3: Add PHPDoc @tutorial tagSymfony3：添加 PHPDoc @tutorial 标签
【发布时间】：2016-10-22 21:35:32
【问题描述】：

在 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。

更新

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

【问题讨论】：

标签： php annotations symfony phpdoc

【解决方案1】：

Symfony 像任何 PHP 框架一样工作，因此它的代码是通过 PHPDoc 记录的，您在文档链接中指出的更多的是 Symfony 在使用 PHPDoc 时所做的“例外”。

在 PHPDoc 中，您可以引用带有 @link 注释的外部链接，添加到类的文档块中，任何 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;
    }
}

【讨论】：

另外，您提供的链接是关于贡献 Symfony 代码（IMO 很适合在您的项目中了解和使用），而不是关于您应该在项目中做什么，您的代码文档是你自己的责任。
链接标签标签与教程标签不同；他们都服务于不同的东西。我想使用教程标签粘贴一些关于如何使用该方法的示例：教程标签在生成 phpDoc 时将“链接”文件的内容导入到描述中。我的问题是如何在 Symfony 中链接到这个文件，或者把它放在哪里，在 Symfony 项目的哪个文件夹中。