PHP टिप्पणियों में अतिरिक्त तारों का उद्देश्य क्या है?

Question

मैंने (अंत में) पीएआर (पीएचपी) कोडिंग मानकों पर पढ़ा है।

/** 
* Here is my comment 
* I Wrote this in a haiku 
* But why put the stars? 
*/ 

के रूप में इस का विरोध किया:

/* 
    Here is a comment 
    No haiku or 
    anything special, but it still works! 
*/ 

Answer 1

/** stuff */ दस्तावेज़ भी DocBlock अंकन के रूप में जाना जाता है।

यह

/** 
* A test function 
* 
* @param foo $bar 
* @return baz 
*/ 
function test(foo $bar) { return new baz; } 

कुछ एडिटर इस का अच्छा इस्तेमाल अपने कोड इनसाइट सुविधा, उस समय कम कर देता है एक बहुत शक्तिशाली उपकरण प्रदर्शन करने के लिए PHP कार्यों, वर्ग, आदि दस्तावेज़ के लिए प्रयोग किया जाता है, जिसे आप देख खर्च करने आपके पुराने समारोह घोषणाएं। Aptana और Zend Studio में यह सुविधा है, शायद अन्य भी।

आप इसे किसी भी प्रकार के एओपी करने के लिए Reflection के साथ संयोजन में भी उपयोग कर सकते हैं, अपनी घोषणाओं के ऊपर डॉकब्लॉक के रनटाइम निरीक्षण कर सकते हैं। वास्तव में, सिद्धांत अपने "सक्रिय रिकॉर्ड" कार्यान्वयन के लिए object attribute map बनाने के लिए इसका उपयोग करता है।

Answer 2

पठनीयता

इस तरह टिप्पणी का उद्देश्य क्या है।

यह स्पष्ट रूप से कोड पढ़ने वाले लोगों को टिप्पणी अनुभाग पर प्रकाश डाला गया है।

Answer 3

मुझे लगता है कि यह ज्यादातर उपस्थिति/पठनीयता के लिए है। कल्पना कीजिए कि आपके पास एक बहुत लंबा टिप्पणी अनुभाग है जो एक स्क्रीन से परे फैला हुआ है। फिर उन तारों को देखते हुए आपको पता चलता है कि यह एक टिप्पणी का हिस्सा है भले ही आप शुरुआत और अंत को नहीं देख सकें।

Answer 4

मैं अजोन और क्वांटिन से सहमत हूं। मुख्य रूप से यह पठनीयता है। हालांकि, एक और बात है।

स्वचालित दस्तावेज जेनरेटर (जैसे डॉक्सिजन) हैं।

इन टिप्पणियों को दस्तावेज़ीकरण में शामिल करने के लिए उन्हें कुछ विशेष टिप्पणी स्वरूपण की आवश्यकता होती है। मेरा मानना ​​है कि इस उद्देश्य के लिए टिप्पणी की इस शैली का उपयोग वास्तव में किया जाता है (निम्नलिखित डॉक्सिजन दस्तावेज पृष्ठ पर देखें - http://www.stack.nl/~dimitri/doxygen/docblocks.html)

Answer 5

डबल ड्रेस्टरिस्क टिप्पणी कुछ दस्तावेज प्रणालियों द्वारा कभी-कभी उपयोग की जाती है। प्रलेखन प्रणाली ब्लॉक को खरीदती है और @Author या @var जैसे कुछ कीवर्ड की तलाश करेगी।

सिंगल तारांकन टिप्पणियों को // टिप्पणियों के रूप में माना जाएगा।

phpdoc देखें http://www.phpdoc.org/docs/latest/guides/types.html

Answer 6

आप अपने PHP संपादन यह एक क्रिया है क्या दिखाने के लिए अलग अलग रंग में कोड पर प्रकाश डाला गया के लिए उत्कृष्ट मुक्त पाठ संपादक jEdit, एक चर आदि है क्या का उपयोग करते हैं

आप के साथ एक ब्लॉक बाहर टिप्पणी तो/* ... */ब्लॉक के अंदर सब कुछ नारंगी जाता है, जिससे कोड को पढ़ना मुश्किल हो जाता है।

यदि आप इसके बजाय/** के साथ टिप्पणी करते हैं ... */तो यह ब्लॉक के सभी अलग-अलग रंगों में बदल जाता है जो अभी भी कोड के विभिन्न हिस्सों को हाइलाइट करते हैं, जिसका अर्थ है कि कोड बहुत पठनीय रहता है।

पी एस। यदि आप नोटपैड का उपयोग करते हैं या अपने PHP कोड को संपादित करने के समान हैं तो मैं दृढ़ता से सुझाव देता हूं कि आपको जेडिट मिल जाए। यह आपको बहुत अधिक समय और निराशा बचाएगा। {},() इत्यादि के प्रारंभ और अंत को स्वचालित रूप से इंगित करने जैसी चीजें