かなり簡単な質問-docblockを作成するとき、構造要素を別の要素と言うべきかどうか@uses、そしていつ他の要素を人々に伝えるべきかをどのように判断する必要があり@seeますか？
私は少しのグーグルと少しのSO検索を運が悪かったのですが、私が見ることができる唯一の違い@usesは、一致する@used-byタグがあるのに対し、一方@see通行であるということです。@usesこれは、 /@used-byが優先されることを意味しますか、@seeそれともそれ以上のものがありますか？
乾杯。
以下のメソッドが@usesタグで識別されるメソッド/プロパティを使用していることを強調したい場合は、@usesを選択します。ただし、@ usesを使用する主な理由は、双方向の@uses--@used-byリンケージを作成することです。@usesを一貫して配置することに注意を払うことは、最終的には、ドキュメント内のメソッド/プロパティを確認し、その上の@used-byタグのリストを確認できることを意味します。これにより、この1つのメソッド/プロパティがどの程度効果を発揮するかが一目でわかります。 。これは、メソッドのコードで使用法が隠されているグローバル変数をリファクタリングする準備をするときに特に役立ちます。
@seeを使用して、以下の方法について、@seeがポイントする場所も一瞥する興味深い理由があることを示します。このメソッドと@seeメソッドによって操作されるクラスプロパティがある場合、特に同様の/関連する方法で、両方のメソッドに@seeタグを配置し、場合によってはそのプロパティに@usesを配置することもできます。
TL; DR？@usesは、メソッドが実際に@usesターゲットを利用していることを示すためにのみ使用します。@seeは、他の「この他のことにも注意する必要がある」という理由で使用します。