OpenLayers एपीआई प्रलेखन बनाम डेवलपर प्रलेखन


10

OpenLayers वेब साइट संदर्भ प्रलेखन के दो सेट प्रदान करती है:

अधिकांश वर्गों के लिए, एपीआई डॉक्स डेवलपर डेवलपरेशन में जो कुछ है, उसका एक छोटा सा उपसमुच्चय है। मुझे लगता है कि मैं आमतौर पर एपीआई डॉक्स में वर्णित सुविधाओं का उपयोग करके बहुत कुछ नहीं कर सकता हूं, इसलिए मैं डेवलपर दस्तावेज़ीकरण का उपयोग करता हूं (और मैं स्रोत और उदाहरण पढ़ता हूं)।

इन दो प्रलेखन सेटों के बीच आधिकारिक अंतर क्या है? क्या एपीआई डॉक्स उन इंटरफेस का वर्णन करते हैं जो स्थिर होने की उम्मीद है? अगर मैं केवल डेवलपर डॉक्यूमेंटेशन में वर्णित विशेषताओं का उपयोग करता हूं, तो क्या मैं भविष्य में होने वाले जोखिम को कम कर सकता हूं?

जवाबों:


3

मुझे अपनी प्रतिक्रिया को थोड़ा ठीक करने के लिए संपादित करना चाहिए। OpenLayers से संबंधित कई मुख्य दस्तावेज हैं:

१ - एक जैसा विकी

2 - एपीआई प्रलेखन

3 - डेवलपर प्रलेखन

4 - अंतिम संस्करण / ट्रंक एपीआई प्रलेखन

5 - अंतिम संस्करण / ट्रंक डेवलपर प्रलेखन

एपीआई दस्तावेज़ीकरण का उद्देश्य एपीआई के स्थिर विवरणों का वर्णन करना है , जबकि डेवलपर्स प्रलेखन अन्य विवरणों की ओर इशारा करते हैं जो ओपनलाइयर अनुप्रयोगों को विकसित करते समय आवश्यक होते हैं।

"OpenLayers कोड में दो प्रकार के गुण / विधियाँ हैं: एक सेट API Methods और गुणों का समूह है। अतिरिक्त आंतरिक गुण भी हैं जो API के संपर्क में नहीं हैं। जावास्क्रिप्ट में निजी सदस्य नहीं होते हैं, इसलिए कोई भी नहीं है। एप्लिकेशन कोड में इन गैर-प्रलेखित विधियों का उपयोग करने के लिए तकनीकी सीमा। हालांकि, हम हर संभव प्रयास करते हैं कि एपीआई, रिलीज के तरीकों और गुणों के बीच एपीआई को बदलने के लिए न करें जो स्पष्ट रूप से घोषित नहीं किए जाते हैं क्योंकि एपीआई तरीके मामूली रिलीज में बदल सकते हैं।

ऊपर दिए गए दस्तावेज़ीकरण "(एपीआई डॉक्टर 2 और 4)" में केवल एपीआई तरीके शामिल हैं। पूर्ण डेवलपर / आंतरिक पुस्तकालय प्रलेखन "(3 और 5)" के नीचे भी उपलब्ध है, लेकिन उपर्युक्त एपीआई प्रलेखन में उपलब्ध नहीं तरीकों को रिलीज के बीच रहने के लिए निर्भर नहीं किया जा सकता है। यदि आप इन डॉक्स में शामिल विधियों का उपयोग करते हैं, तो आपको OpenLayers की छोटी रिलीज़ के बीच चलने के लिए अपने एप्लिकेशन कोड में संशोधन करना पड़ सकता है। "

अच्छे उत्तर: आपको नवीनतम संस्करण के एपीआई डॉक्स पर निर्भर होना चाहिए, बिंदु 2 से लिंक, यह सुनिश्चित करने के लिए कि आपका कोड नए संस्करणों के सापेक्ष सुरक्षित है।

गलत जवाब <>

मेरी वास्तविक सही प्रतिक्रिया पर आधारित है । इसी तरह की चर्चा यहाँ है

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.