मैं अन्य वातावरण के बारे में नहीं जानता, लेकिन जब यह बड़े (अक्सर खुले स्रोत) PHP परियोजनाओं की बात आती है, जो अन्य लोगों ने लिखा है, तो phpXRef एक निरपेक्ष जीवन रक्षक है (विशेषकर यदि डॉक्टर को ऑनलाइन रखा गया है और Google इसे अनुक्रमित कर सकता है)।
यहां तक कि एक बुरी तरह से टिप्पणी की गई परियोजना कम से कम मुझे यह ट्रैक करने में मदद कर सकती है कि चीजें कहां परिभाषित की गई हैं और उनका उपयोग कहां किया जाता है (उदाहरण के लिए जब रिफैक्टिंग)।
जब अच्छी तरह से टिप्पणी की जाती है, तो परिणामी पृष्ठ कोडबेस के लिए एक आदर्श बाइबिल के करीब होते हैं (वैसे भी मेरे उपयोग के लिए)।
इसके अलावा, मेरी पसंद की गई आईडीई टिप्पणी ब्लॉक को स्वतः उत्पन्न करेगी (यदि मैं टाइप करता हूं तो **) जो मेरे लिए लगभग 75% टिप्पणी का काम करता है। यह आश्चर्यजनक है कि मुझे अपने कोडर जीवन भर करने से कितनी बेवकूफी भरी चीजें रोक दी गई हैं, क्योंकि मुझे अन्य लोगों (और मुझे भविष्य में) को समझाना होगा कि मैं क्या कर रहा हूं। जब डॉक्टर के लिए मेरी टिप्पणी विधि से बड़ी है, तो इसका मतलब यह है कि आमतौर पर मेरे पास पर्याप्त कॉफी नहीं है और मैं थोड़ा कठिन सोचना चाह सकता हूं।
वे स्वयं-समान टिप्पणी ब्लॉक भी इनलाइन पूरा करने में "मदद" पाठ का निर्माण करते हैं, इसलिए मैं ठीक वही देख सकता हूं जो मैं (दूसरे कोडर द्वारा) फ़ंक्शन कॉल लिख रहा था। यह मेरे लिए एक बड़े पैमाने पर उत्पादकता को बढ़ावा देने वाला है (विशेष रूप से उन दुर्लभ मामलों में जहां कुछ अन्य सहायक डेवलपर ने "अच्छाई के लिए / do-not X" के लिए लिखा है - जो बहुत दर्द को बचा सकता है।
मैं पर्याप्त तनाव नहीं कर सकता कि यह जटिल (और अक्सर बुरी तरह से नामित) PHP परियोजनाओं और कम अक्सर उपयोग किए जाने वाले तरीकों में तर्क क्रम में निर्दिष्ट इनपुट प्रकारों के लिए कितना उपयोगी है। यहां तक कि अपने स्वयं के कोड के साथ, मैं हमेशा याद नहीं रख सकता कि मैंने एक उम्र में जो कुछ नहीं छुआ है, उसके लिए मैंने क्या तर्क दिए हैं।
एक उदाहरण में इसका मतलब था कि आवर्ती समस्याओं का स्रोत यह था कि किसी कारण से, जो पूर्व डेवलपर्स पर बुरी तरह से प्रतिबिंबित होता है, कुछ कार्यों और यहां तक कि स्थिरांक को बड़ी संख्या में स्थानों में परिभाषित किया गया था (अतिरिक्त "मज़ा" के लिए असंगति की डिग्री के साथ) । यह प्रोजेक्ट से दूर जाने का संकेत था।
मेरे शामिल होने से पहले शुरू होने वाली बड़ी परियोजनाओं में, मैं देख सकता हूं कि कौन से डेवलपर (उन्होंने एक नाम और ईमेल के साथ वर्ग फ़ाइल को टैग किया है) ने कक्षा बनाई और बस सही डेवलपर को खोजने और उससे बात करने में सक्षम होने में बेहद मददगार है।
स्वचालित कार्य सूचियों - @todo टैग का उपयोग करना (जिस तरह की परियोजनाओं में मैं अपने आप को काम में पाता हूं) का अर्थ है कि प्रलेखन सामान का ट्रैक रख सकता है जिसे कुछ और काम करने की आवश्यकता होती है (या ऐसी सुविधाएँ जिन्हें लापता होने के लिए स्वीकार किया जाता है)। फिर से मेरा आईडीई इस पर नज़र रखता है और अकेले ही एक अच्छे मार्गदर्शक के रूप में कार्य करता है जो पहले मेरे ध्यान की आवश्यकता है।
अन्त में (और मेरे लिए बहुत ही महत्वपूर्ण) यह उस सभी को लिखने के गैर-तुच्छ ओवरहेड को हटा देता है और फिर इसे तब तक बनाए रखने की कोशिश करता है जब कुछ (कई पढ़े) कोडर्स बदलाव करते हैं और दस्तावेजी रखरखाव के लिए बात नहीं करते हैं।
तो, कारणों में शामिल हैं:
- बाद के डेवलपर्स को समय की बचत करना,
- जहाँ कार्य कहा जाता है (और परिभाषित),
- मूर्खतापूर्ण कोडिंग,
- ढूँढना (जैसा कि एक और इशारा किया है) जब कुछ स्पष्ट रूप से गायब है,
- सरल बनाने की क्रिया
- (कई मामलों में) एक विचार प्राप्त कर रहा था कि डेवलपर क्या करने की कोशिश कर रहा था (यह मानते हुए कि वह या उसने कुछ नोट्स छोड़ दिए हैं)।
- यदि परियोजना पर्याप्त जटिल है, तो कई लाइसेंस चल रहे हैं (कोई मज़ा नहीं) मैं जल्दी से देख सकता हूं कि किसी भी अनुभाग में कौन से लाइसेंस लागू होते हैं। बेशक, यह एक पक्ष बोनस है।
- एक परियोजना फ़ाइल के बारे में बात करने का विचार प्राप्त करना।
- स्वचालित कार्य सूचियाँ
इसके अलावा, एक बटन के स्पर्श में नुकीले बालों वाले मालिकों को खुश रखने के मूल्य को कम मत समझो।
संक्षेप में "ऑटो प्रलेखन टिप्पणियाँ" मेरी कोडिंग आदतों के लिए महत्वपूर्ण हैं। मुझे यकीन है कि बहुत से लोग हैं जो सोचते हैं कि यह लंगड़ा है, लेकिन मैं यह भी सुनिश्चित करता हूं कि कुछ निष्पक्ष लोग हैं जो वास्तव में जानते हैं कि मैं क्या कह रहा हूं। मुझे नहीं पता कि मैं phpXRef (और मेरी पसंदीदा आईडीई) की खोज करने से पहले कैसे बच गया।