2015-11-01 5 views
7

PHP12ocs में उपयोग किए जाने पर @internal टैग का अर्थ क्या होता है और यह कैसे काम करता है? मैंने इस टैग के लिए the documentation पढ़ा है और इस परिभाषा को प्राप्त कर लिया है।@ आंतरिक वास्तव में क्या मतलब है और इसका उपयोग कैसे करें?

@ अनंत टैग का उपयोग यह इंगित करने के लिए किया जाता है कि संबंधित संरचनात्मक तत्व इस एप्लिकेशन या पुस्तकालय के आंतरिक तत्व हैं। इसका उपयोग पाठ के एक टुकड़े को सम्मिलित करने के लिए एक लंबे विवरण के अंदर भी किया जा सकता है जो केवल इस सॉफ़्टवेयर के डेवलपर्स के लिए लागू होता है।

मुझे इसका सारांश मिलता है लेकिन मुझे समझ में नहीं आता कि मैं वास्तव में इसे किसी प्रोजेक्ट में कैसे उपयोग करूं? मैंने उदाहरण पढ़ा है और मेरी समझ यह है कि @internal के रूप में चिह्नित एक फ़ंक्शन का अर्थ है कि इसका उपयोग सॉफ़्टवेयर के हिस्से के रूप में किया जाना चाहिए और बाहरी द्वारा उपयोग नहीं किया जाना चाहिए। उदाहरण के लिए, एक PHP लाइब्रेरी में, यदि कोई फ़ंक्शन @internal के रूप में चिह्नित किया गया है, तो यह लाइब्रेरी द्वारा प्रदान की जाने वाली सार्वजनिक API का हिस्सा नहीं है।

मेरे सवालों का:

  • @internal की मेरी समझ सही है? यदि नहीं, तो सही उपयोग क्या है?
  • यदि मेरी समझ सही है, तो PhpStorm मेरे @internal कार्यों को क्यों रोकता है जिसका अर्थ यह है कि उनका उपयोग नहीं किया जा रहा है? मैं @internal के रूप में चिह्नित फ़ंक्शन का सही तरीके से उपयोग कैसे करूं?
+1

यहां उनके दस्तावेज़ों का एक उदाहरण दिया गया है: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.internal.pkg.html आप इसे सही ढंग से समझ रहे हैं, हालांकि मुझे यकीन नहीं है कि क्यों PhpStorm इसे हमला करता है बाहर जब तक यह गलत तरीके से स्वरूपित नहीं है। –

+2

यह केवल उस कारण से बाहर निकलता है: आपको यह बताने के लिए कि इस विधि/क्षेत्र/वर्ग/आदि का उपयोग कक्षा के बाहर नहीं किया जाना चाहिए। मेरा मानना ​​है कि एटीएम यह "बहिष्कृत" शैली के लिए स्टाइल का उपयोग करता है। बात यह है - यह केवल मूलभूत समर्थन है - टिकट अभी तक बंद नहीं हुआ है - प्रगति पर अधिसूचित होने के बाद आपको देखने के लिए आपका स्वागत है: https://youtrack.jetbrains.com/issue/WI-22284 – LazyOne

+0

दोनों धन्यवाद जानकारी और PhpStorm मुद्दे के लिंक के लिए! मुझे खुशी है कि मेरी समझ स्पष्ट थी और यह केवल PhpStorm के समर्थन के साथ एक मुद्दा था जो मुझे भ्रमित कर रहा था। – allejo

उत्तर

0

कुछ के लिए मामूली हो सकता है लेकिन यह ध्यान रखना एक अच्छी बात है कि यदि संभव हो तो एक समारोह निजी घोषित करना शायद @internal का उपयोग करने से बेहतर है।

यह नहीं कह रहा कि इस टैग के लिए कोई वैध उपयोग नहीं है लेकिन अगर आपको लगता है कि इसका उपयोग करने की आवश्यकता है तो अपने डिजाइन की समीक्षा करना हमेशा अच्छा विकल्प है।

संबंधित मुद्दे