PHPDoc वैकल्पिक पैरामीटर

Question

SO पर इस प्रकार के पहले से ही 2 समान प्रश्न हैं लेकिन कोई भी जवाब काम नहीं कर रहा है।

phpdoc, वैकल्पिक के रूप में मेरे कार्यों में वैकल्पिक पैरामीटर पहचान करने के लिए उदाहरण के लिए प्रतीत होता है नहीं:

/** 
* Opens the connection and sets encoding 
* 
* @param string $encoding Encoding. 
*/ 
public function __construct($encoding='UTF-8') 
{ 
    $this->connect_mysqli(); 
    $this->set_encoding_mysqli($encoding); 
} 

यह वैकल्पिक होने के रूप में $ एन्कोडिंग पहचान नहीं है या मैं कुछ यहाँ याद आ रही है? मैं वास्तव में गूगल और प्रलेखन पढ़ने के लिए कोशिश की, लेकिन सब मैंने पाया है:

आप वास्तविक कोड है कि पैरामीटर वैकल्पिक है में संकेत नहीं कर रहे हैं ("$ paramname = 'एक डिफ़ॉल्ट मान' 'के माध्यम से), तो आपको पैरामीटर के विवरण में उल्लेख करना चाहिए कि पैरामीटर वैकल्पिक है।

तो मैं अपने कोड के साथ कोई समस्या नहीं देखते हैं, लेकिन सब मैं दस्तावेज में मिलता है: "__construct (स्ट्रिंग $ एन्कोडिंग)", कोई संकेत नहीं कहीं भी है कि पैरामीटर वैकल्पिक है।

Answer 1

कड़ाई से बोलते हुए, PHP को "वैकल्पिक पैरामीटर" नहीं पता है, लेकिन डिफ़ॉल्ट मान वाले पैरामीटर, जिन्हें फ़ंक्शन या विधि कहा जाता है, को छोड़ा जा सकता है। ठीक है, कि अंत एक वैकल्पिक पैरामीटर पर है, लेकिन अपने

@param string $encoding Encoding. 

क्योंकि डिफ़ॉल्ट मान एक स्ट्रिंग है पूरी तरह से सही यहाँ, है। कौन सा दस्तावेज़ बताने की कोशिश करता है कि आप इसे अपने आप को

@param string $encoding (optional) Encoding. 

मैं आपसे सहमत हूँ की तरह का उल्लेख करना चाहिए, कि एक अंकन

तरह

__construct([$encoding]) 

या

__construct($encoding = 'UTF-8') 

अच्छा होगा है। आपको एक बग रिपोर्ट पोस्ट कर सकते हैं

https://github.com/phpDocumentor/phpDocumentor2/issues?state=open

अद्यतन: एहसास, यह पहले से ही उल्लेख किया है कि https://github.com/phpDocumentor/phpDocumentor2/search?q=optional&type=Issues