शब्द "स्व-दस्तावेजीकरण कोड" कहने का एक और तरीका है "पठनीय कोड।" अपने आप से, यह इस प्रलेखन या अच्छी टिप्पणियों को प्रतिस्थापित नहीं करेगा, लेकिन उनके साथ या उनके बिना यह निश्चित रूप से आपके जीवन और आपके सहयोगियों के जीवन को आसान बना देगा।

आइए स्व-दस्तावेजीकरण कोड बनाने के लिए कुछ महत्वपूर्ण सिद्धांतों को देखें।

"जादुई संख्या" का उपयोग न करें

बताओ, इस पंक्ति का क्या अर्थ है?

if (students.length > 23) { 

जाँच करता है कि क्या 23 से अधिक छात्र हैं? और इसका क्या मतलब है? ठीक २३, और क्यों नहीं, २४ कहें?

एक जादू संख्या संदर्भ के बिना एक संख्या है। आपको इस संदर्भ को समझने के लिए समय और प्रयास खर्च करने की आवश्यकता होगी। अनावश्यक काम से छुटकारा पाएं, तुरंत स्पष्ट रूप से संख्या को पदनाम दें:

 const maxClassSize = 23; if (students.length > maxClassSize) { 

अब कोड पढ़ने का प्रयास करें। हम यह नहीं जांचते हैं कि "23 से अधिक छात्र हैं या नहीं", लेकिन "कक्षा के छात्रों की तुलना में अधिक छात्र हैं या नहीं"।

चरों के लिए स्पष्ट नामों का उपयोग करें

मुझे पता नहीं क्यों, लेकिन इससे पहले कि मैं चर नाम बनाने के लिए लगातार डरता था। जो मेरे लिए बेवकूफ था, क्योंकि rStuNms और fStuNms r awStudentNames और filteredStudentNames की तुलना में भयानक हैं।

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

 const fStuNms = stus.map(s => sn) //    const filteredStudentNames = students.map(student => { return student.name; }); 

एक और अच्छा टिप कन्वेंशन (नामकरण परंपराओं) का उपयोग करना है। यदि चर बूलियन है, तो इसके साथ शुरू करें या है ( isEnrolled: true )। यदि चर एक सरणी है, तो बहुवचन ( छात्रों ) का उपयोग करें। कई संख्याएँ न्यूनतम या अधिकतम के साथ शुरू होनी चाहिए। और फ़ंक्शन नाम में एक क्रिया होनी चाहिए, उदाहरण के लिए, createSchedule या updateNickname । सुविधाओं की बात हो रही है ...

छोटे नामित कार्यों को लिखें

चर केवल कोड पढ़ने का एकमात्र तरीका नहीं हैं। एक युवा प्रोग्रामर के रूप में, मैंने कोड दोहराव से बचने के लिए केवल फ़ंक्शन का उपयोग किया। मेरे लिए असली रहस्योद्घाटन यह था कि, सबसे पहले, यह समझ में आता है कि क्या हो रहा है , इसका वर्णन करने के लिए फ़ंक्शन बनाने के लिए ।

इस कोड को देखने के लिए कुछ सेकंड लें और कहें कि यह क्या करता है:

 const handleSubmit = (event) => { event.preventDefault(); NoteAdapter.update(currentNote) .then(() => { setCurrentAlert('Saved!') setIsAlertVisible(true); setTimeout(() => setIsAlertVisible(false), 2000); }) .then(() => { if (hasTitleChanged) { context.setRefreshTitles(true); setHasTitleChanged(false); } }); }; 

अब कोड के लिए भी ऐसा ही करें:

 const showSaveAlertFor = (milliseconds) => () => { setCurrentAlert('Saved!') setIsAlertVisible(true); setTimeout( () => setIsAlertVisible(false), milliseconds, ); }; const updateTitleIfNew = () => { if (hasTitleChanged) { context.setRefreshTitles(true); setHasTitleChanged(false); } }; const handleSubmit = (event) => { event.preventDefault(); NoteAdapter.update(currentNote) .then(showSaveAlertFor(2000)) .then(updateTitleIfNew); }; 

ऐसा लगता है कि अधिक वर्ण हैं, लेकिन कितना अधिक पठनीय है, है ना? तार्किक संचालन को छोटे नामित कार्यों में वितरित करने की आवश्यकता थी। इसके अलावा, छोटे कार्य स्वयं अधिकांश स्थितियों में पढ़ने के लिए आवश्यक नहीं हैं - ये कार्यान्वयन विवरण हैं। कोड को समझने के लिए, बस सबसे ऊपरी फ़ंक्शन को देखें, जिसमें आसानी से समझ में आने वाली घटनाओं की एक श्रृंखला शामिल है।

लेकिन आगे - अधिक, थोड़ी देर बाद आपको एहसास होगा कि इस तरह के छोटे कार्यों का पुन: उपयोग करना बहुत आसान है। पुन: प्रयोज्यता बेहतर पठनीयता का परिणाम है, न कि इसके विपरीत।

उपयोगी परीक्षण विवरण जोड़ें

संभवतः कम से कम बात की गई स्व-प्रलेखित परीक्षण हैं, लेकिन व्यर्थ में।

मान लीजिए कि हमारे पास एक फ़ंक्शन है:

 const getDailySchedule = (student, dayOfWeek) => { 

कल्पना करें कि इसमें कई अलग-अलग ऑपरेशन शामिल हैं: यह एक महीने के लिए शेड्यूल प्राप्त करता है; अगर आज एक दिन की छुट्टी है, तो एक खाली सरणी देता है; यदि छात्र अतिरिक्त कक्षाओं में नामांकित है, तो दिन के अंत में उन्हें जोड़ता है, आदि। सामान्य तौर पर, आप इस विचार को समझते थे: फ़ंक्शन जटिल है और इसके काम के एल्गोरिथ्म को सरल शब्दों में कहीं लिखना अच्छा होगा।

एक टिप्पणी में इसे फिट करने की कोशिश करना एक बुरा विचार है: एक टिप्पणी एक बार अप्रचलित हो जाएगी और इस तथ्य को नहीं कि यह समय में सही हो जाएगी। क्या आप जानते हैं कि ऑपरेशन एल्गोरिथ्म की रिकॉर्डिंग कहां तक ​​उचित है? परीक्षणों में:

 describe('getDailySchedule ', () => { it("   ", () => { it('  ,   ', () => { it('     ', () => { 

यह कोड में टिप्पणी के बिना कोड टिप्पणी करने का सबसे सुरुचिपूर्ण तरीका है।

निचला रेखा: चतुराई के मुकाबले पठनीयता अधिक महत्वपूर्ण है

कोई भी ऐसा कोड लिख सकता है जो खुद के लिए समझ में आता है; एक अच्छा डेवलपर कोड लिखता है जो दूसरों के लिए समझ में आता है । किसी एक व्यक्ति द्वारा बनाए गए कुछ महत्वपूर्ण हैं, जिसका अर्थ है कि जितनी जल्दी या बाद में अन्य लोग आपके कोड को पढ़ेंगे। लेकिन यहां तक ​​कि अगर आपको यकीन है कि केवल आप ही किसी कोड को देखेंगे, तो विचार करें कि आप, आज और एक महीने में, इस कोड को याद रखने की क्षमता के मामले में अलग-अलग लोग हैं।