web-dev-qa-db-ja.com

Docblockで@usesタグを使用することが推奨されないのはなぜですか?

インラインドキュメント標準を参照してください

注:このタグは過去に使用されましたが、使用されるべきではありません。

何ができる?

私はプラグイン/テーマのソースからコーデックスを構築するためのプラグインを構築しています、そして私は@usesタグが関数をフックにリンクしフックを関数にリンクするのに完璧であると思います。

6

100%確信はありませんが、@usesの使用法は@seeでカバーできるためだと思います。

PhpDocumentorのドキュメントから

@usesは@seeと非常によく似ています。形式と構造の詳細については@seeのドキュメントを参照してください。 @usesタグは@seeと2つの点で異なります。 @seeは一方向のリンクです。つまり、@seeタグを含むドキュメントには他のドキュメントへのリンクが含まれています。 @usesタグは、@usesタグを含むドキュメントにリンクしている他のドキュメント内に仮想の@usedbyタグを自動的に作成します。言い換えると、リターンリンクが自動的に追加されることを除けば、@ seeとまったく同じです。

もう1つの違いは、@ useはリンク先の要素とその要素の説明を1つしか受け入れないことです。

おそらく、WP人たちは、2つのタグを同じようにしても1つだけ維持する価値はないと考えました。

ところで、@usesは素晴らしいタグです。もしあなたがそれをサポートしたいのならそれをやるだけでドキュメンテーションにそのサポートを文書化してください。

5
gmazzap