2012-03-29 12 views
2

クラスプロパティがとりうるさまざまな値とこれにどのような影響があるかをphpdocが記録する方法はありますか?例えば: -PHPDoc:さまざまなクラスプロパティオプションをドキュメント化する方法

class SomeClass { 

    /** 
    * Cell text align 
    * 
    * null - table default 
    * l - left align 
    * r - right align 
    * c - centre align 
    * j - justify 
    */ 
    public $align; 

    Some code 
} 

は、それが定義リストや、同様にそれらを向けるだろうように、値記述のペアははphpdocによって解析されるようにする方法はありますか?このような

+0

無関係:変数にこれらの値が含まれていることを確認する方法を教えてください。パブリックゲッターやセッターで保護された変数について考えましたか? – cmbuckley

答えて

2

何かがドキュメント出力の<ul>になります:the manual page on DocBlock description detailsから

class SomeClass { 

    /** 
    * Cell text align 
    * 
    * Possible values: 
    * - null - table default 
    * - l - left align 
    * - r - right align 
    * - c - centre align 
    * - j - justify 
    */ 
    public $align; 

    // Some code 
} 

+0

素晴らしい!どうもありがとうございました! – rgvcorley

+0

すぐに私たちはPHPDocumentor 2 @ www.phpdoc.orgを楽しみにしていますが、まだこの記事の時点では終わっていません。 – Webnet

関連する問題