मैं फ़ोटोशॉप, इलस्ट्रेटर और इनडिज़ीन के लिए जावास्क्रिप्ट स्क्रिप्टिंग मार्गदर्शिका के माध्यम से पढ़ रहा हूं। एपीआई पढ़ने के लिए वास्तव में मुश्किल है क्योंकि यह मानता है कि मैं कुछ शॉर्टेंड सम्मेलनों को जानता हूं। समस्या इस विशेष स्क्रिप्टिंग गाइड तक ही सीमित नहीं है। मैं दर्जनों को सूचीबद्ध कर सकता हूं जो एक ही समस्या पेश करते हैं।नए अक्षरों के लिए एपीआई दस्तावेज कैसे पढ़ा जाए?
जब मैं किसी ऐसे व्यक्ति के रूप में एपीआई पढ़ता हूं जो दिन में 24 घंटे कोड में नहीं रहता है, तो मैं कुछ मूल रूप से देखना चाहता हूं और सबसे बुनियादी रूप में कोड में एक सरल उदाहरण देखना चाहता हूं। लेकिन अक्सर इसे पहली बार समझना आसान नहीं होता है।
यहां एक उदाहरण है। मैं फ़ोटोशॉप में जावास्क्रिप्ट द्वारा किसी आइटम का रंग बदलने का तरीका देख रहा हूं। तो मैं पीडीएफ खोजता हूं और "fillColor" ढूंढता हूं। मुझे यह दस्तावेज़ों में मिलता है:
fillPath
([fillColor]
[, mode]
[, opacity]
[, preserveTransparency] [, feather]
[, wholePath] [, antiAlias])
जब मैं इसे पढ़ता हूं, तो पहली नज़र में इसका कोई मतलब नहीं होता है। ब्रैकेट क्यों हैं और मुझे कैसे पता चलेगा कि मुझे उन्हें कार्यान्वयन में उपयोग नहीं करना चाहिए? ब्रैकेट में कॉमा क्यों हैं? मुझे पता है कि कोड एक नमूना मैंने पाया है, जो इस है से तरह दिखना चाहिए:
myPath.fillPath(myNewColor)
अगर मैं उदाहरण नहीं देखा था, मैं होता कभी एपीआई कोड से दिव्य कि वह यह है कि कैसे इस विधि लागू होने पर देखना चाहिए। किसी और ने इंगित किया कि इस विधि के लिए एक विस्तृत उदाहरण इस तरह दिख सकता है:
myPath.fillPath(mynewColor, {
mode: RGB,
opacity: .5
})
ठीक है। मैं देखता हूं कि मैं निहित वैकल्पिक पैरामीटर छोड़ सकता हूं। ठीक। लेकिन फिर से, मैंने कभी एपीआई से अनुमान लगाया होगा।
तो, क्या वहां कुछ रहस्यमय दस्तावेज़ है जो लोगों को एपीआई दस्तावेज पढ़ने के बारे में बताता है? ऐसा क्यों लिखा जाता है? मुझे लगता है कि पहले ज्ञान क्या है? ऐसा क्यों है, और इसके बारे में सोचने से रोकने के लिए मैं क्या कर सकता हूं और इसे "प्राप्त" कर सकता हूं, इसलिए मैं अगली एपीआई को और अधिक खुशी से पढ़ और कार्यान्वित कर सकता हूं?
तो एपीआई दस्तावेज इस तरह से क्यों लिखा गया है कि बारहमासी न्यूब्स/हैकर्स/DIYers खुद को भ्रमित करने के लिए?
क्या एपीआई संदर्भ दस्तावेज़ में कोई परिचय है जो उनके वाक्य रचनात्मक सम्मेलनों का वर्णन करता है? –
उस व्यक्ति के लिए जिसने मतदान करने के लिए मतदान किया था: मेरा मानना है कि इस प्रश्न में योग्यता है, और अगर मैं कर सकता हूं तो "बंद न करें"। यह एक प्रश्न नहीं है जिसे मैंने पहले देखा है (या सुना है), यह एक वैध प्रोग्रामिंग से संबंधित समस्या को संबोधित करता है, और जब मैं प्रोग्रामिंग से संबंधित चीजों को सिखाता हूं तो मुझे व्यक्तिगत रूप से उत्तर उपयोगी लगता है। –
डेरेक: मुझे लगता है कि आप मूल पोस्ट में बोल्ड वाक्यों में से एक चूक गए हैं। यदि आप "एपीआई दस्तावेज को कैसे पढ़ा जाए" पर Google हैं, तो पहले 10 परिणामों में जानकारी "अमूर्त", "अपूर्ण", "भ्रमित" जैसी चीजें कहती है, इस प्रकार मेरे प्रश्न के बिंदु को मजबूत करती है। – dbonneville