क्या php में @var के अर्थ की टिप्पणी

Question

मैं इस php टिप्पणी में (@var) एक बहुत देखते हैं और कोई सुराग नहीं इसका क्या मतलब है। कृपया बताओ।

// example.php (taken from yii framework application code) 

<?php 
/* @var $this CategoriesController */ 
/* @var $data Categories */ 
?> 

<div class="view"> 

    <b><?php echo CHtml::encode($data->getAttributeLabel('idCategory')); ?>:</b> 
    <?php echo CHtml::link(CHtml::encode($data->idCategory), array('view', 'id'=>$data->idCategory)); ?> 
    <br /> 
</div> 

Answer 1

आप कक्षा प्रकार के डेटा प्रकार को दस्तावेज़ करने के लिए @var टैग का उपयोग कर सकते हैं।

डेटाप्रकार एक वैध पीएचपी प्रकार (पूर्णांक, स्ट्रिंग, bool, आदि), ऑब्जेक्ट का प्रकार, या बस "मिश्रित" के लिए एक वर्ग के नाम होना चाहिए। phpDocumentor वैकल्पिक वर्णन असंशोधित, और डिफ़ॉल्ट रूप में प्रदर्शित करेगा "मिश्रित" अगर डेटाप्रकार वर्तमान

http://www.phpdoc.org/docs/latest/references/phpdoc/tags/var.html

@var टैग के साथ नहीं है, यह प्रकार दस्तावेज़ के लिए संभव है और एक वर्ग संपत्ति का कार्य। प्रदान किए जाने पर इसमें इंगित करने के लिए एक प्रकार होना चाहिए; दूसरी ओर वर्णन वैकल्पिक है अभी तक इस तरह के साहचर्य सरणियों के रूप में जटिल संरचनाओं, के मामले में सिफारिश की।

@var टैग मई में एक बहु-पंक्ति विवरण है और स्पष्ट सीमा की आवश्यकता नहीं है।

यह जब हर संपत्ति के साथ इस टैग का उपयोग करने का दस्तावेजीकरण की सिफारिश की है।

यह टैग phpdoc में एक बार प्रति प्रॉपर्टी की तुलना में अधिक नहीं होते हैं और प्रकार संपत्ति की संरचनात्मक तत्वों के लिए सीमित है चाहिए।

उदाहरण:

class DemoVar 
{ 
    /** 
    * Summary 
    * 
    * @var object Description 
    */ 
    protected $varWithDescriptions; 

    /** 
    * @var \DemoVar $instance The class instance. 
    */ 
    protected static $instance; 

    /** 
    * Summary for varWithWrongType 
    * 
    * @var boolean The varWithWrongType. Boolean will be put in the type. 
    */ 
    protected $varWithWrongType = array(); 
} 

Answer 2

है phpdoc, स्वचालित प्रलेखन बनाने के लिए:

phpdoc

Answer 3

http://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.var.pkg.html

Answer 4

वे phpdoc टिप्पणी कर रहे हैं और आम तौर पर आईडीई-typehinting/कोड पूरा करने के लिए उपयोग किया जाता है (कभी-कभी इसे प्रलेखन- पीढ़ी, लेकिन इस परिदृश्य में नहीं)। उनके पास आवेदन पर कोई प्रासंगिकता नहीं है और बिना किसी घटना के हटाया जा सकता है।

Answer 5

यह एक इनलाइन प्रकार संकेत में है।

उदा

/* @var bool */ 
$switch 

इस मामले में यह मतलब है $this प्रकार CategoriesController की है और $data प्रकार Categories

अक्सर प्रकार हिंट करने के लिए IDEs द्वारा प्रयोग किया जाता का है।