නඩත්තු කළ හැකි කේතයක් ලිවීම සඳහා උපදෙස්
කේතය ලිවීම යනු වැඩසටහනක් "ක්රියාත්මක කිරීමට" පමණක් නොවේ. ප්රායෝගිකව, මෘදුකාංග සංවර්ධන කාලයෙන් සැලකිය යුතු කොටසක් පවතින කේතය කියවීම, පිරිපහදු කිරීම සහ සංවර්ධනය කිරීම සඳහා වැය කරනු ලැබේ - ඔබේම හෝ වෙනත් කෙනෙකුගේ වේවා. එබැවින්, නඩත්තු කළ හැකි කේතය ලිවීමේ හැකියාව ඕනෑම ක්රමලේඛකයෙකුට තීරණාත්මක කුසලතාවයකි. නඩත්තු කළ හැකි කේතය නඩත්තු වියදම් අඩු කරයි, විශේෂාංග එකතු කිරීම් වේගවත් කරයි, දෝෂ අවම කරයි, සහ කණ්ඩායම් සහයෝගීතාවය වඩාත් ඵලදායී කරයි. පිරිසිදු, පැහැදිලි සහ කල් පවතින කේතයක් ලිවීම සඳහා ප්රායෝගික උපදෙස් කිහිපයක් මෙන්න.
1. "දක්ෂතාවයට" වඩා කියවීමේ පහසුවට ප්රමුඛත්වය දෙන්න.
ඕනෑවට වඩා "දක්ෂ" කේතයක් තේරුම් ගැනීමට බොහෝ විට අපහසුය. උදාහරණයක් ලෙස, ඉතා සංක්ෂිප්ත කේත පේළියක් ලිවීම අලංකාර ලෙස පෙනුනද, නැවත කියවන විට එය ව්යාකූල විය හැකිය. එය ටිකක් දිගු වුවද පැහැදිලි විසඳුමක් තෝරන්න. කියවීමේ හැකියාව ආයෝජනයකි: ඔබට කේතය එක් වරක් පමණක් ලිවිය හැකිය, නමුත් ඔබ එය බොහෝ වාරයක් කියවනු ඇත.
උදාහරණයක් ලෙස, බහු මෙහෙයුම් තනි ප්රකාශනයකට කැදවීම වෙනුවට, ඒවා අර්ථවත් විචල්ය නම් සහිත පියවරවලට වෙන් කරන්න. මෙය පාඨකයාට අනුමාන කිරීමකින් තොරව වැඩසටහනේ අභිප්රාය තේරුම් ගැනීමට උපකාරී වේ.
2. පැහැදිලි සහ ස්ථාවර නම් කිරීම භාවිතා කරන්න.
විචල්ය, ශ්රිත සහ පන්ති නම් ඔබේ කේතය සඳහා "පළමු ලේඛන පේළිය" වේ. හොඳ නම් ඒවායේ දත්තවල ආකෘතිය පමණක් නොව ඒවායේ භූමිකාව හෝ අරමුණ විස්තර කළ යුතුය. උදාහරණයක් ලෙස, `userList` `ul` ට වඩා තොරතුරු සපයන අතර, `calculateTotalPrice()` `ctp()` ට වඩා පැහැදිලි වේ.
පැහැදිලිකමට අමතරව, නම් කිරීම ද අනුකූල විය යුතුය. ඔබ විචල්ය සඳහා camelCase භාවිතා කරන්නේ නම්, ඔබේ ව්යාපෘතිය පුරාම එයට ඇලී සිටින්න. පන්ති සඳහා, ඔබ කැමති භාෂා සම්මුතිය නම් PascalCase භාවිතා කරන්න. අනුකූලතාව කේතය ඒකාකාරී බවක් දැනෙන අතර කියවීමේදී මානසික බර අඩු කරයි.
3. "තනි වගකීම" මූලධර්මය යොදන්න.
කේතය නඩත්තු කිරීමට අපහසු වීමට ප්රධාන හේතුවක් වන්නේ ඕනෑවට වඩා දේවල් කරන ශ්රිත හෝ පන්ති ය. තනි වගකීම් මූලධර්මය යෝජනා කරන්නේ කේත ඒකකයකට තිබිය යුත්තේ එක් ප්රාථමික වගකීමක් පමණක් බවයි. ඕනෑවට වඩා දිගු ශ්රිතයක් සාමාන්යයෙන් එය බිඳ දැමිය යුතු බවට ලකුණකි.
උදාහරණයක් ලෙස, ආදානය එකවර වලංගු කරන, මිල ගණන් ගණනය කරන, ගෙවීම් ද්වාරයක් සම්බන්ධ කරන සහ ඊමේල් යවන "චෙක්අවුට් ක්රියාවලිය" ශ්රිතයක් පරීක්ෂා කිරීමට අපහසු වන අතර වෙනස් කිරීමට අපහසු වනු ඇත. එය වෙනම ශ්රිතවලට (වලංගුකරණය, ගණනය කිරීම, ගෙවීම, දැනුම්දීම) කැඩීමෙන්, ඔබට එක් කොටසකට අනෙක් කොටස් බිඳ දැමීමෙන් තොරව වෙනස්කම් කළ හැකිය.
4. අනුපිටපත් කිරීමෙන් වළකින්න (වියළි), නමුත් එය ඉක්මවා නොයන්න.
DRY (Don't Repeat Yourself) යනු වැදගත් මූලධර්මයකි: ඔබ එකම කේතයේ කොටස කිහිප වතාවක් පිටපත් කළහොත්, කුඩා වෙනසක් සඳහා ඔබට සියල්ල සංස්කරණය කිරීමට සිදුවනු ඇත. මෙය දෝෂ සහිතයි. විසඳුම වන්නේ ශ්රිතයකට හෝ මොඩියුලයකට නැවත නැවත තර්කනය උපුටා ගැනීමයි.
කෙසේ වෙතත්, අධික ලෙස අනුපිටපත් කිරීම වළක්වා ගැනීම කියවීමේ හැකියාවට හානි කළ හැකි බව මතක තබා ගැනීම වැදගත්ය. කේත කොටස් දෙකක් සමාන ලෙස පෙනුනත් ඇත්ත වශයෙන්ම වෙනස් සන්දර්භයන් තිබේ නම්, "වියුක්ත කිරීම" බල කිරීමෙන් කේතය වඩාත් සංකීර්ණ විය හැකිය. ශේෂයක් සොයා ගන්න: අනුපිටපත් කිරීම සැබවින්ම අර්ථවත් වන අතර එකට වෙනස් වීමේ හැකියාව ඇති විට ප්රතිසංස්කරණය කරන්න.
5. පිළිවෙලට ව්යාපෘති ව්යුහයක් සාදන්න
පැහැදිලි ෆෝල්ඩර ව්යුහයක් නඩත්තු කිරීමේ පහසුවට බලපායි. ගොනු වර්ගය අනුව පමණක් නොව, විශේෂාංගය හෝ මොඩියුලය අනුව ගොනු කාණ්ඩ කරන්න, විශේෂයෙන් විශාල ව්යාපෘති සඳහා. හොඳ ව්යුහයක් මඟින් නවකයින්ට ව්යාපෘති ගෘහ නිර්මාණ ශිල්පය තේරුම් ගැනීමට පහසු වේ.
උදාහරණයක් ලෙස, ඔබගේ සියලුම UI සංරචක එක් විශාල ෆෝල්ඩරයකට දැමීම වෙනුවට, ඔබට ඒවා විශේෂාංගය අනුව බෙදිය හැකිය: `auth/`, `profile/`, `checkout/`, යනාදී වශයෙන්. මෙම ප්රවේශය ඔබේ ව්යාපෘතිය වර්ධනය වන විට පරිමාණයට උපකාරී වේ.
6. සංකීර්ණත්වය සීමා කර තාර්කික ප්රවාහය අනුගමනය කිරීම පහසු කරන්න.
කැදැලි if-else ප්රකාශ, බොහෝ කොන්දේසි සහ විශේෂ ව්යතිරේකවලින් පිරුණු කේතයක් පවත්වා ගැනීම බොහෝ විට දුෂ්කර ය. ඔබේ තර්කනය සරල කිරීමට උත්සාහ කරන්න. කැදැලි අඩු කිරීමට ඔබට කලින් ආපසු පැමිණීම වැනි ශිල්පීය ක්රම භාවිතා කළ හැකිය, නැතහොත් සංකීර්ණ තර්කනය සුදුසු ලෙස නම් කළ හැකි කුඩා ශ්රිතවලට ගෙන යා හැකිය.
ශ්රිතයකට පරාමිතීන් ඕනෑවට වඩා තිබේ නම්, එය සංකීර්ණතාව ද සංඥා කරයි. පරාමිතීන් වඩා හොඳින් සංවිධානය කිරීමට සහ ඒවා දිගු කිරීම පහසු කිරීමට වින්යාස වස්තුවක් (හෝ දත්ත ව්යුහයක්) භාවිතා කිරීම සලකා බලන්න.
7. ඉලක්කගත අදහස් ලියන්න.
අදහස් පැහැදිලි කේතයක් සඳහා ආදේශකයක් නොවේ. "කේතය කරන්නේ කුමක්ද" යන්න ඔබට පැහැදිලි කිරීමට අවශ්ය නම්, එය බොහෝ විට වඩාත් කියවිය හැකි ලෙස සකස් කළ යුතුය. කෙසේ වෙතත්, යමක් "ඇයි" කරන්නේ යන්න පැහැදිලි කිරීම සඳහා අදහස් තවමත් ප්රයෝජනවත් වේ, විශේෂයෙන් සැලසුම් තීරණ, පද්ධති සීමාවන් හෝ නිශ්චිත ව්යාපාරික හේතු තිබේ නම්.
හොඳ අදහස් සඳහා උදාහරණ ලෙස කාර්ය සාධන සීමාවන් නිසා විශේෂිත ඇල්ගොරිතමයක් භාවිතා කරන්නේ මන්දැයි පැහැදිලි කිරීම හෝ වලංගුකරණ රීතියක් නියාමනයක් අනුගමනය කරන නිසා එය අමුතු ලෙස පෙනෙන්නේ මන්දැයි පැහැදිලි කිරීම ඇතුළත් වේ. මේ ආකාරයෙන්, අනෙක් අය කේතය "පිළිවෙලට" නොතබන අතර වැදගත් තර්කනය බිඳ නොදමනු ඇත.
8. කේත හැඩතල ගැන්වීම සහ විලාස මාර්ගෝපදේශ භාවිතා කරන්න
අනුකූල හැඩතල ගැන්වීම මඟින් කේතය වෘත්තීය පෙනුමක් ලබා දෙන අතර කියවීමට පහසු කරයි. තිබේ නම් ස්වයංක්රීය ලින්ට් සහ හැඩතල භාවිතා කරන්න (උදා: JavaScript සඳහා ESLint + Prettier, Python සඳහා Black, හෝ Go සඳහා gofmt). මෙම මෙවලම් සමඟින්, කණ්ඩායම්වලට පරතරය සහ ඉන්ඩෙන්ටේෂන් ගැන කරදර විය යුතු නැත, මන්ද සියල්ල ස්වයංක්රීයව හසුරුවනු ලැබේ.
තනි හෝ ද්විත්ව උපුටා දැක්වීම් භාවිතා කළ යුතුද, ගොනු නම් කරන්නේ කෙසේද, දිගු රේඛා බිඳ දැමිය යුත්තේ කවදාද යනාදිය සඳහා ශෛලී මාර්ගෝපදේශ ද උපකාරී වේ. මෙවැනි කුඩා ප්රමිතීන් දිගු කාලීනව විශාල වෙනසක් ඇති කළ හැකිය.
9. නැවත සකස් කිරීමේදී විශ්වාසය පවත්වා ගැනීම සඳහා පරීක්ෂණ ලියන්න.
නඩත්තු කළ හැකි කේතය පිරිසිදු පමණක් නොව වෙනස් කිරීමටද ආරක්ෂිතයි. ස්වයංක්රීය පරීක්ෂණ (ඒකක පරීක්ෂණ, ඒකාබද්ධ පරීක්ෂණ) ඔබේ වෙනස්කම් ස්ථාපිත හැසිරීම් බිඳ නොදමන බවට සහතික වේ. පරීක්ෂණ නොමැතිව, හඳුනා නොගත් දෝෂ ඇතිවීමේ අවදානම නිසා කේතය වැඩිදියුණු කිරීමට මිනිසුන් බිය වෙති.
තීරණාත්මක අංශ සමඟ ආරම්භ කරන්න: මිල ගණනය කිරීමේ කාර්යයන්, වට්ටම් නීති, වලංගුකරණය, හෝ නිතර වෙනස් වන මොඩියුල. කාලයත් සමඟ, පරීක්ෂණ ආවරණය වර්ධනය වන අතර ප්රතිගාමීත්වයන්ට එරෙහිව ශක්තිමත් ආරක්ෂාවක් සපයනු ඇත.
10. නිතිපතා සහ මැනිය හැකි ලෙස ප්රතිසංස්කරණය සිදු කරන්න
නඩත්තුව යනු අඛණ්ඩ ක්රියාවලියකි. නැවත සකස් කිරීම යන්නෙන් අදහස් කරන්නේ "සියල්ල නැවත ලිවීම" නොවේ, නමුත් කේතයේ හැසිරීම වෙනස් නොකර එහි ගුණාත්මකභාවය වැඩි දියුණු කරන කුඩා වැඩිදියුණු කිරීම් ය. ඔබ කේතයේ කොටසක් ස්පර්ශ කරන විට නැවත සකස් කිරීමක් උපලේඛනගත කරන්න: ටිකක් පිළිවෙලට කරන්න, නම් කිරීම නිවැරදි කරන්න, අධික ලෙස දිගු කාර්යයක් බිඳ දමන්න, නැතහොත් මිය ගිය කේතය ඉවත් කරන්න.
කුඩා, නිතිපතා ප්රතිසංස්කරණයන් විශාල, කලාතුරකින් සිදුවන ප්රතිසංස්කරණයන්ට වඩා ආරක්ෂිතයි. තවද සෑම විටම වෙනස්කම් වලට පෙර සහ පසු ප්රමාණවත් පරීක්ෂණ හෝ අවම වශයෙන් පරීක්ෂා කිරීම සහතික කරන්න.
11. වැදගත් තීරණ ලේඛනගත කරන්න
කේත අදහස් වලට අමතරව, හොඳ ව්යාපෘතිවල සාමාන්යයෙන් සංක්ෂිප්ත ලියකියවිලි ඇත: යෙදුම ක්රියාත්මක කරන්නේ කෙසේද, එය ගොඩනඟන්නේ කෙසේද, පරිසරය වින්යාස කරන්නේ කෙසේද සහ ඉහළ මට්ටමේ වාස්තු විද්යාත්මක පැහැදිලි කිරීමක්. මෙම ලියකියවිලි පුළුල් විය යුතු නැත, නමුත් එය නිවැරදි හා පහසුවෙන් සොයාගත හැකි විය යුතුය. `README.md` වැනි හොඳින් නඩත්තු කරන ලද ගොනුවක් නව සාමාජිකයින් ඇතුළත් කිරීමේදී බොහෝ කාලයක් ඉතිරි කර ගත හැකිය.
ප්රධාන තාක්ෂණික තීරණයක් තිබේ නම් (උදා: විශේෂිත දත්ත සමුදායක්, ගෘහ නිර්මාණ රටාවක් හෝ ඒකාබද්ධ කිරීමේ සීමාවක් තෝරා ගැනීම), තාර්කිකත්වය ලේඛනගත කරන්න. මෙය කණ්ඩායමට සන්දර්භය තේරුම් ගැනීමට සහ එකම සාකච්ඡාව නැවත නොකිරීමට උපකාරී වේ.
වසා දැමීම
නඩත්තු කළ හැකි කේතය හොඳ පුරුදු වල ප්රතිඵලයකි: පැහැදිලිව ලිවීම, වගකීම් බිඳ දැමීම, අනුකූලතාව පවත්වා ගැනීම, සංකීර්ණතාව අඩු කිරීම සහ පරීක්ෂණ සමඟ වෙනස්කම් ආරක්ෂා කිරීම. කිසිදු කේතයක් පරිපූර්ණ නොවේ, නමුත් කණ්ඩායම ගුණාත්මකභාවය සඳහා කැපවී සිටින්නේ නම් සෑම ව්යාපෘතියක්ම අඛණ්ඩව වැඩිදියුණු කළ හැකිය. ඉහත ඉඟි ක්රියාත්මක කිරීමෙන්, ඔබ අද පමණක් නොව, ඉදිරි මාස සහ වසරවලදීද සමෘද්ධිමත් වීමට වඩා හොඳින් සන්නද්ධ වනු ඇත.
