2016-06-21 7 views
1

Symfony we can use PHPDocアノテーションでは、Symfonyプロジェクトを使用してPHPDocブロック内のチュートリアルをどのように参照できるのでしょうか。しかし、どのように、どこで、私は私のsymfonyプロジェクトの内部でそれらのファイルを配置する必要がありsymfony3:PHPDoc @tutorialタグを追加

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

:我々は、彼らがこのファイルphpDocumentor/phpDocumentor.pkgを参照していることがわかりthe PHPDoc documentation example

symfonyで使用されている@packageアノテーションと@subpackageアノテーションare notも知っておくべきです。

更新

私は、メソッドを使用する方法についていくつかの例を貼り付けチュートリアルタグを使用したい:PHPDOCを生成するときに、チュートリアルタグが記述に「リンク」ファイルの内容をインポートします。私の問題は、Symfonyプロジェクトのどのフォルダに、Symfonyのこのファイルにリンクするか、どこに置くかです。

答えて

0

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; 
    } 
} 
+0

また、あなたが与えられたリンクは(知っているし、あなたのプロジェクトで使用するIMO優れていること)symfonyのコードに貢献する程度ではなく、あなたのプロジェクトに何をすべきかについてです、あなたコードの文書化はあなたの責任で行ってください。 – chalasr

+0

リンクタグタグはチュートリアルタグとは異なります。彼らはどちらも異なるものを提供します。チュートリアルタグを使用して、このメソッドを使用する方法の例を貼り付けます。チュートリアルタグは、phpDocを生成するときに、リンクされたファイルの内容を説明にインポートします。私の問題は、Symfonyプロジェクトのどのフォルダに、Symfonyのこのファイルにリンクするか、どこに置くかです。 – numediaweb

関連する問題