2011-02-14 8 views
5

दस्तावेज करने का उचित तरीका क्या है define() का उपयोग करके निरंतर परिभाषित दस्तावेज़ का कोई उचित तरीका है? @var वास्तव में समझ में नहीं आता है। केवल एक चीज जिसे मैं सोच सकता हूं टैग को छोड़ना है, और केवल PHPdoc टिप्पणी में विवरण लिखें।phpdoc: स्थिर

उत्तर

6

phpDocumentor पहचानते या @const टैग का उपयोग नहीं करता है। phpDocumentor कोड में "परिभाषित" कीवर्ड को देखता है जब स्थिरता पहचानता है। इसके आउटपुट टेम्पलेट्स स्थिरांक के रूप में सूचीबद्ध आउटपुट दस्तावेज में सभी स्थिरांक दिखाएंगे। निरंतर डॉकब्लॉक में आवश्यक एकमात्र चीज एक विवरण है, हालांकि यदि आपको लगता है कि आपको उनकी आवश्यकता है तो कई अन्य "मानक" टैग की अनुमति है [1]।

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html#procedural.define

1

@const का उपयोग करें।

/** 
    * @const FOO Bar 
    */ 
define('FOO', 'Bar'); 

Documentation (क्षमा करें, केवल डॉक्स मैं पा सकते हैं जर्मन में हैं।)

+0

मैं उस पर आया था, हालांकि, मुझे इसका कहीं और उल्लेख नहीं मिल रहा है और नेटबीन इसे ऑटो-पूर्ण संकेत नहीं दिखाता है। – Matty

1

आप वास्तव में @type उपयोग करने के लिए, Github PHP Documentation देखना चाहते हैं।

संबंधित मुद्दे