2013年3月28日木曜日

phpDocumentor:private クラス変数が出力されない

phpDocumentorでprivate クラス変数が出力されない。
または
How to document private variable in phpdoc.

class Sample {
/**
  * りんご(APPLE)
  * @var string
  */
   private $apple = null;
  ...
}
というふうにコメントを記述しているのにprivateのクラス変数が出力されません。
しかも、これがprivateではなくpublicやvarならば出力されます。

そもそもデフォルトでphpDocumentorはprivate変数を出力しないようになっているようなのです。
@accessタグにまつわるバグじゃないんかいと思わないでもないんですが・・・

privateのクラス変数を出力するにはコンパイルに-ppオプションを指定してやる必要があります。

phpdoc –pp -t ./doc -d ./website -o HTML:Smarty: HandS

※-pp:--parseprivate

このオプションでphpdocを実行することで。private変数も出力してくれます。
すっかりはまりました。

0 件のコメント:

コメントを投稿

注: コメントを投稿できるのは、このブログのメンバーだけです。