phpdoc मानक?

Question

उदाहरण:

/** 
* This function will determine whether or not one string starts with another string. 
* @param string $haystack <p>The string that needs to be checked.</p> 
* @param string $needle <p>The string that is being checked for.</p> 
* @param boolean $case[optional] <p>Set to false to ignore case(capital or normal characters)</p> 
* @return boolean <p>If the $haystack string does start with the $needle string, the return will be true. False if not.</p> 
*/ 
function endsWith($haystack,$needle,$case=true) { 
    if($case){return (strcmp(substr($haystack, strlen($haystack) - strlen($needle)),$needle)===0);} 
    return (strcasecmp(substr($haystack, strlen($haystack) - strlen($needle)),$needle)===0); 
} 

वैकल्पिक पैरामीटर डिफ़ॉल्ट रूप से true को तैयार है। मैं यह इंगित करना चाहता हूं कि दस्तावेज़ में डिफ़ॉल्ट सेटिंग क्या है। क्या ऐसा करने का कोई मानक तरीका है या क्या मुझे इसे विवरण में उल्लेख करना है?

Answer 1

The doc says:

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

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