प्रैक्टिसिंग रेल्स खत्म हो गई है! शुक्रवार, फरवरी 13 तक 25% की छूट प्राप्त करें।
जब आप कोड लिखते हैं, तो प्रश्न आपके दिमाग में आते हैं लगातार :मैं इस विधि को कैसे कहूँ? यह क्या विकल्प लेता है? यदि मैं किसी संख्या के बजाय किसी वस्तु को पास कर दूं तो क्या होगा?
ये प्रश्न आपकी उत्पादकता को नष्ट कर देते हैं। जब आप तुरंत उत्तर नहीं जानते हैं, तो आप भूल जाते हैं कि आप क्या कर रहे थे। आप अपने प्रवाह से बाहर निकल जाते हैं, और जहां आपने छोड़ा था वहां वापस जाने में आधा घंटा लगता है।
तो बिना धीमा किए आपको अपने आवश्यक उत्तर कैसे मिलेंगे?
फास्ट लुकअप
जब आप API दस्तावेज़ देखते हैं तो गति महत्वपूर्ण होती है। आप अपना उत्तर प्राप्त करना चाहते हैं और जितनी जल्दी हो सके बाहर निकलना चाहते हैं। अन्यथा, ट्रैक से बाहर निकलना बहुत आसान है। मैं यह नहीं गिन सकता कि मुझे कितनी बार एक विधि के मापदंडों को जानने की आवश्यकता है और किसी तरह एक घंटे के लिए रेडिट पर शर्मनाक पाठ संदेशों को देखना समाप्त कर दिया।
त्वरित दस्तावेज़ीकरण के लिए, आपको अन्य सभी चीज़ों के लिए डैश, मैक या ज़ील की आवश्यकता होगी। इन उपकरणों के साथ, आप अपने कीबोर्ड पर दो कुंजियां दबा सकते हैं और आप जो कर रहे हैं उसके बारे में सोचने के बिना आवश्यक दस्तावेज़ ला सकते हैं।
लेकिन पहले उन्हें थोड़ा सा सेटअप चाहिए।
एक बार जब आप इनमें से किसी एक ऐप को डाउनलोड कर लें, तो ये दो काम करें:
-
आपके द्वारा उपयोग की जाने वाली लाइब्रेरी के लिए डॉक्ससेट डाउनलोड करें।
मैं रूबी, रेल, सीएसएस, एचटीएमएल, और जावास्क्रिप्ट के लिए दस्तावेज़ लेता हूं, और यह इसके बारे में है। यदि कोई जटिल रत्न है जिसका आप बहुत उपयोग करते हैं, जैसे नोकोगिरी, तो उन दस्तावेज़ों को भी पकड़ें। लेकिन अति न करें - यदि आपके पास बहुत अधिक दस्तावेज़ हैं, तो कौन से का पता लगाने का प्रयास करते समय आप धीमे हो जाएंगे
concat
जिस विधि से आप वास्तव में मतलब रखते हैं। -
वैश्विक खोज शॉर्टकट सेट करें . मैक पर, मैं आमतौर पर विकल्प-स्पेस का उपयोग करता हूं।
यह वही है जो डैश को "सिर्फ एक और डॉक्टर साइट" से पूरी तरह से आवश्यक टूल में बदल देता है। एक बार जब आप वैश्विक खोज शॉर्टकट सेट कर लेते हैं, तो आप विकल्प-स्पेस को हिट कर सकते हैं, टाइप करना शुरू कर सकते हैं, अपनी ज़रूरत के दस्तावेज़ देख सकते हैं, विकल्प-स्पेस को फिर से हिट कर सकते हैं, और बिना यह जाने कि आपने अभी-अभी क्या किया है, अपना उत्तर प्राप्त कर सकते हैं। इससे पहले कि आपको पता चले कि आपके पास वे हैं, आप अपने API प्रश्नों का उत्तर दे सकते हैं।
विवरण, प्रश्न और टिप्पणियां
दुर्भाग्य से, कभी-कभी एपीआई डॉक्स में वे सभी विवरण नहीं होते हैं जिन्हें आप जानना चाहते हैं। या आपको यह जानने की आवश्यकता हो सकती है कि कोई सुविधा अंदर से कैसे काम करती है।
इन सवालों के जवाब देने के लिए आपको गति का त्याग करना होगा। लेकिन एक दस्तावेज़ीकरण साइट है जो उस गति को विवरण और समुदाय से बदल देती है।
APIDock
APIDock केवल रूबी, रेल और RSpec को कवर करता है। लेकिन यह अभी भी मददगार है:
-
APIDock आपको बताएगा कि रेल विधियों को कब हटा दिया गया था, और इसके बजाय आपको क्या उपयोग करना चाहिए। यह 1.0 तक वापस रेल में संस्करण-से-संस्करण परिवर्तनों का ट्रैक रखता है। इसलिए यदि आप लीगेसी रेल कोड के साथ काम कर रहे हैं, तो यह एक अविश्वसनीय संसाधन है।
-
बहुत सी API विधियों में टिप्पणियाँ हैं, जो रेल डेवलपर्स द्वारा दी गई हैं। टिप्पणियाँ वास्तव में अच्छी हैं। APIDock के साथ, आप किनारे के मामलों और सामान्य समस्याओं के बारे में पहले सुनेंगे आप उनमें भाग लेते हैं।
आपका नया दस्तावेज़ कार्यप्रवाह
तो, आप यह सब एक साथ कैसे रखते हैं?
- जब आप एपीआई के बारे में कोई प्रश्न पूछना चाहते हैं, तो डैश या ज़ील को तुरंत लाने के लिए हॉटकी का उपयोग करें।
- यदि आपको अधिक विवरण की आवश्यकता है, तो वेब पर जाएं। पहले APIDock आज़माएं, खासकर यदि आप किसी पुराने रेल ऐप में API खोज रहे हैं।
जब आप तुरंत दस्तावेज़ीकरण पा सकते हैं, तो यह आपकी रेल उत्पादकता को बदल देगा। आप न केवल अधिक केंद्रित रहेंगे, आप उन पुस्तकालयों और ढांचे के बारे में और भी जानेंगे जिन पर आप निर्भर हैं।
आप अपने द्वारा उपयोग किए जाने वाले प्रत्येक टूल के बारे में सब कुछ नहीं जान सकते। आप हमेशा किसी न किसी स्तर पर दस्तावेज़ीकरण पर निर्भर रहेंगे। इसलिए जब आप चीजों को देखते हैं तो समय बचाने के लिए अभी थोड़ा समय बिताएं। यह आपके संपूर्ण प्रोग्रामिंग करियर के दौरान बड़े पैमाने पर भुगतान करेगा।