रेल्स उत्पादकता बढ़ाएं: सवालों को अपने वर्कफ्लो को बाधित करने से रोकें

प्रैक्टिसिंग रेल्स आ गया है! शुक्रवार, 13 फरवरी तक 25% छूट पर प्राप्त करें।

जब आप कोड लिखते हैं, तो सवाल लगातार आपके दिमाग में आते हैं: मैं इस मेथड को कैसे कॉल करूं? यह कौन से विकल्प लेता है? अगर मैं नंबर के बजाय ऑब्जेक्ट पास करूं तो क्या होगा?

ये सवाल आपकी उत्पादकता को नष्ट कर देते हैं। जब आप तुरंत उत्तर नहीं जानते हैं, तो आप भूल जाते हैं कि आप क्या कर रहे थे। आप अपने फ्लो से बाहर निकल जाते हैं, और जहां आप छोड़ गए थे वहां वापस आने में आधा घंटा लग जाता है।

तो आप धीमे हुए बिना आवश्यक उत्तर कैसे ढूंढते हैं?

तेज़ लुकअप

API डॉक्यूमेंटेशन देखते समय गति महत्वपूर्ण है। आप अपना उत्तर प्राप्त करना चाहते हैं और जितनी जल्दी हो सके बाहर निकलना चाहते हैं। अन्यथा, ट्रैक से उतरना बहुत आसान है। मैं गिन नहीं सकता कि कितनी बार मुझे किसी मेथड के पैरामीटर्स जानने की आवश्यकता हुई और किसी तरह मैं एक घंटे तक रेडिट पर शर्मनाक टेक्स्ट मैसेज देखता रह गया।

तेज़ डॉक्यूमेंटेशन के लिए, आप मैक के लिए डैश (Dash), या बाकी सब के लिए ज़ील (Zeal) चाहेंगे। इन टूल्स के साथ, आप अपने कीबोर्ड पर दो कुंजियां दबा सकते हैं और बिना यह सोचे कि आप क्या कर रहे हैं, आवश्यक डॉक्स ला सकते हैं।

लेकिन उन्हें पहले थोड़ा सेटअप चाहिए।

एक बार जब आप इनमें से कोई ऐप डाउनलोड कर लेते हैं, तो ये दो चीजें करें:

1. उन लाइब्रेरीज़ के डॉकसेट डाउनलोड करें जिनका आप उपयोग करते हैं।

   मैं रूबी, रेल्स, CSS, HTML, और जावास्क्रिप्ट के लिए डॉक्स लेता हूं, और बस इतना ही। यदि कोई जटिल जेम है जिसका आप बहुत उपयोग करते हैं, जैसे Nokogiri, तो उन डॉक्स को भी लें। लेकिन अति न करें - यदि आपके पास बहुत सारे डॉक्स हैं, तो आप यह पता लगाने की कोशिश में धीमे हो जाएंगे कि आप वास्तव में किस concat मेथड का मतलब है।

2. ग्लोबल सर्च शॉर्टकट सेट करें। मैक पर, मैं आमतौर पर विकल्प-स्पेस का उपयोग करता हूं।

   यही वह चीज है जो डैश को "सिर्फ एक और डॉक साइट" से पूरी तरह से आवश्यक टूल में बदल देती है। एक बार जब आप ग्लोबल सर्च शॉर्टकट सेट कर लेते हैं, तो आप विकल्प-स्पेस दबा सकते हैं, टाइप करना शुरू कर सकते हैं, आवश्यक डॉक्स देख सकते हैं, फिर से विकल्प-स्पेस दबा सकते हैं, और यह समझे बिना भी अपना उत्तर प्राप्त कर सकते हैं कि आपने अभी क्या किया। आप अपने API सवालों का उत्तर दे सकते हैं इससे पहले कि आप जानते थे कि आपके पास वे थे।

विवरण, प्रश्न, और टिप्पणियां

दुर्भाग्य से, कभी-कभी API डॉक्स में वे सभी विवरण नहीं होते जो आप जानना चाहते हैं। या आपको यह जानने की आवश्यकता हो सकती है कि कोई फीचर अंदर से कैसे काम करता है।

आपको इन सवालों का जवाब देने के लिए गति का त्याग करना होगा। लेकिन एक डॉक्यूमेंटेशन साइट है जो उस गति को विवरण और समुदाय के साथ बदल देती है।

APIDock

APIDock केवल रूबी, रेल्स, और RSpec को कवर करता है। लेकिन यह अभी भी मददगार है:

• APIDock आपको बताएगा कि रेल्स मेथड्स कब डिप्रिकेट हुए थे, और आपको इसके बजाय क्या उपयोग करना चाहिए। यह रेल्स में वर्जन-टू-वर्जन परिवर्तनों को 1.0 तक ट्रैक करता है। इसलिए यदि आप लिगेसी रेल्स कोड के साथ काम कर रहे हैं, तो यह एक अविश्वसनीय संसाधन है।

• बहुत सारे API मेथड्स में रेल्स डेवलपर्स द्वारा योगदान की गई टिप्पणियां हैं। टिप्पणियां वास्तव में अच्छी हैं। APIDock के साथ, आप एज केस और सामान्य समस्याओं के बारे में उनसे टकराने से पहले सुनेंगे।

आपका नया डॉक्यूमेंटेशन वर्कफ्लो

तो, आप यह सब एक साथ कैसे रखते हैं?

1. जब आपके पास API के बारे में कोई सवाल हो, तो डैश या ज़ील को जल्दी से लाने के लिए हॉटकी का उपयोग करें।
2. यदि आपको अधिक विवरण की आवश्यकता है, तो वेब पर जाएं। पहले APIDock आज़माएं, खासकर यदि आप पुराने रेल्स ऐप में API खोज रहे हैं।

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

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