एक समान नस के रूप में कैसे हो सकता है स्रोत परियोजनाओं को उनके डिजाइन या वास्तुकला के बारे में प्रलेखन के बिना सफल हो सकता है? प्रश्न, मैं उत्सुक हूँ: अंत उपयोगकर्ता प्रलेखन में इतने सारे पुस्तकालयों की कमी क्यों है?
मेरा विचार यह है:
- ज्यादातर सभी इस बात से सहमत हैं कि सोर्स कोड पढ़ना सोर्स कोड लिखने से ज्यादा मुश्किल है।
- प्रलेखन के बिना, उस पुस्तकालय का उपयोग करने के लिए किसी को पुस्तकालय के स्रोत कोड को पढ़ना चाहिए।
- इसलिए, undocumented पुस्तकालय का उपयोग करना खरोंच से पुस्तकालय को फिर से बनाने की तुलना में अधिक काम है।
- नतीजतन, यदि आप चाहते हैं कि लोग आपके पुस्तकालय का उपयोग करें, तो आप बहुत अच्छी तरह से यह सुनिश्चित करेंगे कि यह दस्तावेज है।
मुझे पता है कि बहुत सारे डेवलपर्स डॉक्स लिखना पसंद नहीं करते हैं, और मैं मानता हूँ कि यह थकाऊ काम हो सकता है। लेकिन यह जरूरी काम है। मैं यहां तक कहूंगा कि दुनिया में सबसे अच्छा प्रोग्रामर का इंटरफ़ेस होने की तुलना में एक पुस्तकालय का अच्छा प्रलेखन है। (लोग हर समय चमकदार पुस्तकालयों का उपयोग करते हैं; कुछ लोग अनिर्दिष्ट पुस्तकालयों का उपयोग करते हैं)
ओह, ध्यान दें कि जब मैं प्रलेखन कहता हूं, तो मेरा मतलब है कि वास्तविक दस्तावेज। Sandcastle / Javadoc / Doxygen boilerplate नहीं।
6
शायद इसलिए कि आपने और मैंने ओपन सोर्स लाइब्रेरीज़ के लिए बहुत कम समय दिया है।
—
एरिक विल्सन
क्योंकि अच्छा प्रलेखन लिखना कठिन है , इसलिए अधिकांश डेवलपर्स उस समस्या को हल करते हैं बस इसे नहीं कर रहे हैं। इसके अलावा, सब कुछ स्पष्ट लगता है जबकि आप कोड लिखने के बीच में हैं। "मेरी लाइब्रेरी का उपयोग करना इतना आसान है कि यह स्व-दस्तावेजीकरण है !" -- हाँ सही।
—
कोडी ग्रे
मैं आपके विचार से पूरी तरह सहमत नहीं हूँ, विशेषकर आपके तीसरे बिंदु से। कोड लिखना हमेशा आसान नहीं होता है।
—
बर्नार्ड