2011-11-14 10 views
2

関数にphpdocを使用する場合、常にクラスのインスタンスを含む引数があります。生成されたphpdocが指定されたクラスにリンクするように、これをphpdocで文書化する方法はありますか?phpDoc、クラスインスタンスは@paramですか?

と同様のもの@param MyClass() $var

実際にはドキュメントにはオブジェクト(stdClass)型のパラメータであるピリオドについての情報もありません。

答えて

5

あなたは括弧を削除するには、それが箱から出して動作するはず必要があります。

@param MyClass $var Parameter takes instance of MyClass 

このための正式な構文は次のとおりです。

@param type [$varname] description 

はあなたが必要とする文書http://manual.phpdoc.org/HTMLframesConverter/default/(を見てください左の@paramをクリックする)

+0

完璧、ありがとう。コードを文書化するために使用されるソフトウェアを作成する開発者は、コードをうまく文書化できません。:) – Naatan

+2

実際には、http://manual.phpdoc.org/HTMLframesConverter/default/をクリックして@paramをクリックしてください。 – halfdan

+0

私はあまりにも速くそれを読んでいる必要があります、感謝:) – Naatan

関連する問題