PHP कोड टिप्पणी मानक

यह बात काफी सामान्य और प्रसिद्ध है,

मैं इसके सिंटैक्स और व्यावहारिक अनुप्रयोग के बारे में बात करूँगा।

PHP में सब कुछ बहुत OOP होगा।

मैं तुरंत आरक्षण करूंगा, यह प्रारूप कक्षाओं, उनके तरीकों और गुणों पर लागू होता है,

और इसलिए कि हमारे मजदूरों के अंत में हमें डबल्स से मूर्ख नहीं बनना चाहिए,

लेकिन खूबसूरती से लिखित प्रलेखन, इस प्रारूप को लागू किया जाना चाहिए।

अभ्यास

तो एक उदाहरण:



पहली नज़र में, यह इतना सुंदर नहीं दिखता है, लेकिन इसके कई फायदे हैं।

मुख्य लाभ मानक है। अब उन सुविधाओं के बारे में जो ज़ेंड और ग्रहण हमें देते हैं:



एक संकेत के रूप में, विकास पर्यावरण हमें फ़ंक्शन का विस्तृत विवरण दिखाता है,

जहां आप देख सकते हैं कि इनपुट किस प्रारूप में होना चाहिए और अंत में हमें क्या मिलेगा। "लेकिन यह सब © नहीं है,"

स्वचालित रूप से दस्तावेज़ बनाने के लिए सिस्टम हैं,

और उनकी मदद से आप हमारी परियोजना का पूरा विवरण प्राप्त कर सकते हैं,

केवल ऊपर वर्णित टिप्पणियों के आधार पर। यह कैसा दिखता है:



यह पृष्ठ ZDE में निर्मित phpDocumetor सिस्टम द्वारा बनाया गया है।

टिप्पणी सिंटैक्स

फ़ंक्शन या विधि के लिए सिंटैक्स

/ **

* नाम या संक्षिप्त विवरण (वर्ग, विधि, संपत्ति, कार्य)

*

* विस्तृत विवरण

* कई लाइनों में

*

* @tag_name मान

* डेटाटाइप लौटाएं

* /



एक संपत्ति के लिए वाक्यविन्यास

/ **

* विवरण

*

* var variable_type

* /

और अंत में, विवरण के साथ टैग की एक सूची:

• @access [निजी | संरक्षित | सार्वजनिक] (आइटम के लिए एक्सेस कंट्रोल)
• @author Antonov A. <andreydust@gmail.com> (वर्तमान आइटम के लेखक)
• @param data_type $ variable_name विवरण (इनपुट पैरामीटर के लिए विवरण)
• वापसी data_type विवरण (किसी फ़ंक्शन या विधि द्वारा लौटाए गए डेटा का प्रकार बताता है)

PhpDocumentor मैनुअल पर पूरी सूची।