برقرار رکڻ وارو ڪوڊ لکڻ لاءِ صلاحون
ڪوڊ لکڻ صرف هڪ پروگرام کي "هلائڻ" لاءِ نه آهي. عملي طور تي، سافٽ ويئر ڊولپمينٽ وقت جو هڪ اهم حصو موجوده ڪوڊ کي پڙهڻ، بهتر ڪرڻ، ۽ ترقي ڪرڻ ۾ خرچ ڪيو ويندو آهي - ڇا توهان جو پنهنجو هجي يا ڪنهن ٻئي جو. تنهن ڪري، برقرار رکڻ وارو ڪوڊ لکڻ جي صلاحيت ڪنهن به پروگرامر لاءِ هڪ اهم مهارت آهي. برقرار رکڻ وارو ڪوڊ سار سنڀال جي خرچن کي گھٽائي ٿو، خاصيتن جي اضافي کي تيز ڪري ٿو، بگ کي گھٽائي ٿو، ۽ ٽيم جي تعاون کي تمام گهڻو اثرائتو بڻائي ٿو. هتي صاف، صاف ۽ پائيدار ڪوڊ لکڻ لاءِ ڪجهه عملي صلاحون آهن.
1. "هوشياري" تي پڙهڻ جي صلاحيت کي ترجيح ڏيو.
ڪوڊ جيڪو تمام گهڻو "هوشيار" آهي اهو سمجهڻ ۾ اڪثر ڏکيو هوندو آهي. مثال طور، ڪوڊ جي هڪ تمام مختصر لائن لکڻ خوبصورت نظر اچي سگهي ٿي، پر ٻيهر پڙهڻ وقت اهو مونجهارو ٿي سگهي ٿو. هڪ واضح حل چونڊيو، جيتوڻيڪ اهو ٿورو ڊگهو هجي. پڙهڻ جي صلاحيت هڪ سيڙپڪاري آهي: توهان صرف هڪ ڀيرو ڪوڊ لکي سگهو ٿا، پر توهان ان کي ڪيترائي ڀيرا پڙهندا.
مثال طور، ڪيترن ئي عملن کي هڪ ئي اظهار ۾ شامل ڪرڻ جي بدران، انهن کي بامعني متغير نالن سان مرحلن ۾ ورهايو. اهو پڙهندڙ کي پروگرام جي ارادي کي سمجهڻ ۾ مدد ڪري ٿو بغير اندازو لڳائڻ جي.
2. واضح ۽ هڪجهڙا نالا استعمال ڪريو
متغير، فنڪشن، ۽ ڪلاس جا نالا توهان جي ڪوڊ لاءِ "دستاويز جي پهرين لائن" آهن. سٺا نالا انهن جي ڪردار يا مقصد کي بيان ڪرڻ گهرجن، نه صرف انهن جي ڊيٽا جي فارميٽ کي. مثال طور، `userList` `ul` کان وڌيڪ معلوماتي آهي، ۽ `calculateTotalPrice()` `ctp()` کان وڌيڪ واضح آهي.
وضاحت کان علاوه، نالو ڏيڻ پڻ هڪجهڙائي هجڻ گهرجي. جيڪڏهن توهان متغيرن لاءِ ڪيمل ڪيس استعمال ڪندا آهيو، ته پوءِ پنهنجي سڄي پروجيڪٽ ۾ ان سان گڏ رهو. ڪلاسن لاءِ، جيڪڏهن اهو توهان جي پسنديده ٻولي جو رواج آهي ته پاسڪل ڪيس استعمال ڪريو. مطابقت ڪوڊ کي هڪجهڙائي محسوس ڪرائيندي آهي ۽ پڙهڻ دوران ذهني بوجھ گهٽائي ٿي.
3. "اڪيلو ذميواري" جي اصول کي لاڳو ڪريو.
ڪوڊ کي برقرار رکڻ ۾ ڏکيائي جي مکيه سببن مان هڪ فنڪشن يا ڪلاس آهن جيڪي تمام گهڻا ڪم ڪن ٿا. سنگل ريسپانسبليٽي اصول اهو مشورو ڏئي ٿو ته ڪوڊ جي هڪ يونٽ ۾ صرف هڪ بنيادي ذميواري هجڻ گهرجي. هڪ تمام ڊگهو فنڪشن عام طور تي هڪ نشاني آهي ته ان کي ٽوڙڻ جي ضرورت آهي.
مثال طور، هڪ "چيڪ آئوٽ پروسيس" فنڪشن جيڪو هڪ ئي وقت ان پٽ جي تصديق ڪري ٿو، قيمتن جو حساب ڪري ٿو، ادائيگي جي گيٽ وي سان رابطو ڪري ٿو، ۽ اي ميلون موڪلي ٿو، ان کي جانچڻ ڏکيو ۽ تبديل ڪرڻ ڏکيو هوندو. ان کي الڳ الڳ ڪمن (تصديق، حساب، ادائيگي، نوٽيفڪيشن) ۾ ورهائڻ سان، توهان ٻين کي ٽوڙڻ کان سواءِ هڪ حصي ۾ تبديليون ڪري سگهو ٿا.
4. نقل (DRY) کان پاسو ڪريو، پر ان کي وڌيڪ نه ڪريو.
DRY (پاڻ کي نه ورجايو) هڪ اهم اصول آهي: جيڪڏهن توهان ڪوڊ جي ساڳئي بلاڪ کي ڪيترائي ڀيرا ڪاپي ڪندا، ته هڪ ننڍڙي تبديلي لاءِ توهان کي هر شيءِ کي ايڊٽ ڪرڻ جي ضرورت پوندي. هي غلطي جو شڪار آهي. حل اهو آهي ته بار بار منطق کي هڪ فنڪشن يا ماڊل ۾ ڪڍيو وڃي.
جڏهن ته، اهو ياد رکڻ ضروري آهي ته گهڻي نقل کان بچڻ پڙهڻ جي صلاحيت کي به نقصان پهچائي سگهي ٿو. جيڪڏهن ڪوڊ جا ٻه ٽڪرا هڪجهڙا نظر اچن ٿا پر اصل ۾ مختلف تناظر آهن، ته "تجريد" کي مجبور ڪرڻ ڪوڊ کي وڌيڪ پيچيده بڻائي سگهي ٿو. هڪ توازن ڳوليو: ريفيڪٽر جڏهن نقل واقعي بامعني هجي ۽ ان ۾ گڏجي تبديل ٿيڻ جي صلاحيت هجي.
5. هڪ صاف سٿري منصوبي جي جوڙجڪ ٺاهيو
هڪ صاف فولڊر جي جوڙجڪ سار سنڀال جي آساني تي اثر انداز ٿئي ٿي. فائلن کي خصوصيت يا ماڊل جي لحاظ کان گروپ ڪريو، صرف فائل جي قسم جي لحاظ کان نه، خاص طور تي وڏن منصوبن لاءِ. هڪ سٺي جوڙجڪ نون ايندڙن لاءِ منصوبي جي فن تعمير کي سمجهڻ آسان بڻائي ٿي.
مثال طور، توهان جي سڀني UI حصن کي هڪ وڏي فولڊر ۾ رکڻ جي بدران، توهان انهن کي خصوصيت جي لحاظ کان ورهائي سگهو ٿا: `auth/`، `profile/`، `checkout/`، وغيره. هي طريقو توهان جي منصوبي جي پيماني ۾ مدد ڪري ٿو جيئن اهو وڌندو آهي.
6. پيچيدگي کي محدود ڪريو ۽ منطقي وهڪري کي آسان بڻايو.
نيسٽڊ جيڪڏهن-ٻيو بيانن، ڪيترن ئي حالتن، ۽ خاص استثنا سان ڀريل ڪوڊ اڪثر برقرار رکڻ ڏکيو هوندو آهي. پنهنجي منطق کي آسان بڻائڻ جي ڪوشش ڪريو. توهان نيسٽنگ کي گهٽائڻ لاءِ ابتدائي واپسي جهڙيون ٽيڪنڪ استعمال ڪري سگهو ٿا، يا پيچيده منطق کي ننڍڙن ڪمن ۾ منتقل ڪري سگهو ٿا جن کي مناسب طور تي نالو ڏئي سگهجي ٿو.
جيڪڏهن ڪنهن فنڪشن ۾ تمام گهڻا پيرا ميٽر آهن، ته اهو پيچيدگي جو اشارو پڻ ڏئي ٿو. پيرا ميٽرز کي بهتر ترتيب ڏيڻ ۽ انهن کي وڌائڻ آسان بڻائڻ لاءِ ڪنفگريشن آبجيڪٽ (يا ڊيٽا اسٽرڪچر) استعمال ڪرڻ تي غور ڪريو.
7. اهڙا تبصرا لکو جيڪي نشانو بڻجن
تبصرا واضح ڪوڊ جو متبادل نه آهن. جيڪڏهن توهان کي وضاحت ڪرڻ جي ضرورت آهي ته "ڪوڊ ڇا ڪندو آهي،" ته شايد ان کي وڌيڪ پڙهڻ لائق بڻائڻ جي ضرورت آهي. تاهم، تبصرا اڃا تائين "ڇو" ڪجهه ڪيو وڃي ٿو ان جي وضاحت لاءِ ڪارآمد آهن، خاص طور تي جيڪڏهن ڊيزائن جا فيصلا، سسٽم جون حدون، يا مخصوص ڪاروباري سبب هجن.
سٺن تبصرن جي مثالن ۾ وضاحت ڪرڻ شامل آهي ته ڪارڪردگي جي حدن جي ڪري هڪ خاص الگورتھم ڇو استعمال ڪيو ويندو آهي، يا هڪ تصديق جو قاعدو ڇو عجيب لڳي ٿو ڇاڪاڻ ته اهو هڪ ضابطي جي پيروي ڪري ٿو. هن طريقي سان، ٻيا ڪوڊ کي "صاف" نه ڪندا ۽ اهم منطق کي ٽوڙيندا.
8. ڪوڊ فارميٽنگ ۽ اسٽائل گائيڊ استعمال ڪريو
مسلسل فارميٽنگ ڪوڊ کي پيشيور ۽ پڙهڻ ۾ آسان بڻائي ٿي. جيڪڏهن موجود هجي ته خودڪار لنٽر ۽ فارميٽر استعمال ڪريو (مثال طور، جاوا اسڪرپٽ لاءِ ESLint + Prettier، Python لاءِ Black، يا Go لاءِ gofmt). انهن اوزارن سان، ٽيمن کي فاصلي ۽ انڊينٽيشن بابت پريشان ٿيڻ جي ضرورت ناهي، ڇاڪاڻ ته هر شيءِ خودڪار طريقي سان سنڀالي ويندي آهي.
اسٽائل گائيڊ پڻ مدد ڪن ٿا: سنگل يا ڊبل ڪوٽس استعمال ڪرڻ، فائلن کي ڪيئن نالا ڏيڻ، ڊگهيون لائينون ڪڏهن ٽوڙڻيون، وغيره. اهڙن ننڍڙن معيارن سان ڊگهي عرصي ۾ وڏو فرق پئجي سگهي ٿو.
9. ريفيڪٽرنگ دوران اعتماد برقرار رکڻ لاءِ ٽيسٽ لکو.
برقرار رکڻ وارو ڪوڊ نه رڳو صاف آهي پر تبديل ڪرڻ لاءِ محفوظ پڻ آهي. خودڪار ٽيسٽ (يونٽ ٽيسٽ، انٽيگريشن ٽيسٽ) ضمانت ڏين ٿا ته توهان جون تبديليون قائم ٿيل رويي کي نه ٽوڙينديون آهن. ٽيسٽن کان سواءِ، ماڻهو ڪوڊ کي بهتر ڪرڻ کان ڊڄندا آهن ڇاڪاڻ ته اڻ ڄاتل بگس جي خطري جي ڪري.
نازڪ حصن سان شروع ڪريو: قيمت جي حساب ڪتاب جا ڪم، رعايت جا ضابطا، تصديق، يا بار بار تبديل ٿيندڙ ماڊلز. وقت سان گڏ، ٽيسٽ ڪوريج وڌندي ۽ رجعت جي خلاف مضبوط تحفظ فراهم ڪندي.
10. ريفيڪٽرنگ باقاعدي ۽ ماپي طور تي ڪريو
سار سنڀال هڪ جاري عمل آهي. ريفيڪٽرنگ جو مطلب "هر شيءِ کي ٻيهر لکڻ" ناهي، پر ننڍيون بهتريون جيڪي ڪوڊ جي معيار کي بهتر بڻائين ٿيون بغير ان جي رويي کي تبديل ڪرڻ جي. جڏهن توهان ڪوڊ جي ڪنهن حصي کي ڇهيو ته ريفيڪٽر شيڊول ڪريو: ٿورو صاف ڪريو، نالو درست ڪريو، تمام گهڻو ڊگهو فنڪشن ٽوڙيو، يا ڊيڊ ڪوڊ هٽايو.
ننڍا، باقاعده ريفيڪٽرنگ وڏن، غير معمولي ريفيڪٽرنگن کان وڌيڪ محفوظ آهن. ۽ هميشه تبديلين کان اڳ ۽ بعد ۾ مناسب جانچ، يا گهٽ ۾ گهٽ چڪاس کي يقيني بڻايو.
11. اهم فيصلا دستاويز ڪريو
ڪوڊ جي تبصرن کان علاوه، سٺن منصوبن ۾ عام طور تي مختصر دستاويز هوندا آهن: ايپليڪيشن ڪيئن هلائجي، ان کي ڪيئن ٺاهيو وڃي، ماحول کي ڪيئن ترتيب ڏجي، ۽ هڪ اعليٰ سطحي آرڪيٽيڪچرل وضاحت. هي دستاويز وسيع هجڻ ضروري ناهي، پر اهو صحيح ۽ ڳولڻ ۾ آسان هجڻ گهرجي. هڪ سٺي نموني برقرار رکيل فائل جهڙوڪ `README.md` نون ميمبرن کي آن بورڊ ڪرڻ ۾ گهڻو وقت بچائي سگهي ٿي.
جيڪڏهن ڪو اهم ٽيڪنيڪل فيصلو آهي (مثال طور، هڪ خاص ڊيٽابيس چونڊڻ، آرڪيٽيڪچرل نمونو، يا انضمام جي رڪاوٽ)، ته دليل کي دستاويز ڪريو. هي ٽيم کي تناظر کي سمجهڻ ۾ مدد ڪري ٿو ۽ ساڳئي بحث کي ورجائڻ کان پاسو ڪري ٿو.
پينوٽ اپ
برقرار رکڻ وارو ڪوڊ سٺين عادتن جو نتيجو آهي: واضح طور تي لکڻ، ذميوارين کي ختم ڪرڻ، مستقل مزاجي برقرار رکڻ، پيچيدگي کي گهٽائڻ، ۽ ٽيسٽن سان تبديلين کي بچائڻ. ڪو به ڪوڊ مڪمل ناهي، پر هر منصوبو مسلسل بهتر ٿي سگهي ٿو جيڪڏهن ٽيم معيار لاءِ پرعزم آهي. مٿي ڏنل صلاحن کي لاڳو ڪرڻ سان، توهان ترقي ڪرڻ لاءِ بهتر طور تي ليس هوندا - نه رڳو اڄ، پر ايندڙ مهينن ۽ سالن ۾ پڻ.
