コメントにメソッドを表記するのに好ましい方法は何ですか？

Question

コメントするときに別の方法を参照することがあります。 PHPでここではいくつかの例：

class A 
{ 
    /** 
    * @see B::bar 
    */ 
    public function foo() 
    { 
     B::bar(); 
    } 
} 

class B 
{ 
    public static function bar() 
    { 
     // ... 
    } 
} 

だから、クラスB内の非静的メソッドbar何があるでしょうか？ 他のメソッドにコメントを付ける最も良い方法は何ですか？

編集

PHPマニュアルはmysqli->affected_rowsだけでなく、PDO::beginTransactionを使用しているようです。しかし、それは方法の名前の後に括弧を含むものではありません。プロとコンは何ですか？メソッドが括弧で囲まれていることは非常に明白です。なぜ、それらを残さないのですか？

Thxで事前に！

Answer 1

演算子を使用して、クラスメソッドではなくインスタンス/オブジェクトメソッドを参照できます。 PHP.netはそのマニュアルでもそうしています（例えばMySQLi classを参照）。

Answer 2

私が書くでしょう：私の様々な変更に関する

class A { 
    // see B::bar() 
    public function foo() { 
     B::bar(); 
    } 
} 

私の最も強く保有意見は、レターボックスのコメントは悪魔の仕事であるということです。あなたの静的なものと非静的なものについては、bar()が静的​​であるかどうかに関わらず、B::bar()を理解し使用して、会話目的の関数定義を参照してください。

実際にA::foo()という関数があってもB::bar()を呼び出すことができなかった場合、私はそのコードを読んでいる人がばかだと、私は彼を助けたいとは思わない。

Answer 3

私の意見では、あなたの例で十分です。 B :: barをB :: bar（）と呼ぶべきです。

あなたは

/** 
* @uses B::bar() 
*/ 

限りドキュメントがあるとして、クラスAに戻って指して、自動的にB :: bar（）のために生成されたドキュメントの@usedbyの参照を作成します@uses php-doc tagを、使用して検討する必要がありますスタティックメソッドは@use、@usedbyまたは@seeには関係なく、@staticだけに関係します。 @usesタグの静的表記は、単に@staticを示すのではなく、bar（）メソッドを探すスコープを伝えます。

Answer 4

のphpDocumentorのドキュメントは、あなたがphpDocumentor manualからも

class A 
{ 
    /** 
    * @see B 
    * @see function bar() 
    */ 
    public function foo() 
    { 
    // ... 
    } 
} 

のようなものを使用することができることを意味すると思わ：

@usesため マニュアルを参照して、@seeすることは非常に似ています@ の形式と構造の詳細はを参照してください。 @usesタグ は@seeと2つの点で異なります。 @seeは 一方向リンクです。つまり、@seeタグを含む のドキュメント には、 という他のドキュメントへのリンクが含まれています。@usesタグ は、他の文書 に、@@usedbyタグを自動的に作成し、@usesタグを含む文書 にリンクしています。他の の単語では、 を除き、@seeとまったく同じです。リターンリンクが自動的に追加されます。