කේතයෙන් අදහස් දැක්වීමට අකමැති කණ්ඩායම් සාමාජිකයෙකු සමඟ මා කටයුතු කරන්නේ කෙසේද?

මගේ කණ්ඩායමේ සාමාජිකයෙක් ඔහුගේ කේතයේ අදහස් දැක්වීම නිරන්තරයෙන් වළක්වයි.

ඔහුගේ කේතය ස්වයං ලේඛනගත කිරීමක් නොවන අතර අනෙක් ක්‍රමලේඛකයන්ට ඔහුගේ කේතය තේරුම් ගැනීමට අපහසු වේ.

ඔහුගේ කේතය අදහස් දැක්වීමට මම කිහිප වතාවක්ම ඔහුගෙන් ඉල්ලා සිටිමි, කෙසේ වෙතත් ඔහු නිදහසට කරුණු ඉදිරිපත් කරයි හෝ පසුව එය කරනු ඇතැයි කියා සිටී. ඔහුගේ කනස්සල්ල වන්නේ අදහස් දැක්වීමට වැඩි කාලයක් ගත වන අතර ව්‍යාපෘති ප්‍රමාද වනු ඇති බවයි.

ඔහුගේ කේතය නිසි ලෙස ලේඛනගත කිරීමට ඔහුට ඒත්තු ගැන්වීමට මට ඉදිරිපත් කළ හැකි තර්කය කුමක්ද?

එම සටහනේ, කේත විවරණ කෙරෙහි අවධානය යොමු කිරීම මා වැරදිද? නැතහොත් මෙය විසඳිය යුතු විශාල ගැටලුවක් පෙන්නුම් කරනවාද?

අදහස් දැක්වීම් පමණක් වඩා හොඳ කේතයක් ලබා නොදෙන අතර "වැඩි අදහස්" සඳහා තල්ලු කිරීම ඔබට /* increment i by 1 */විලාසිතාවේ අදහස් වලට වඩා ටිකක් වැඩි වනු ඇත.

එබැවින් ඔබට එම අදහස් අවශ්‍ය වන්නේ මන්දැයි ඔබගෙන්ම විමසන්න . "එය හොඳම පුහුණුව" යන්න ඔබට තේරෙන්නේ නැත්නම් තර්කයක් ලෙස ගණන් නොගනී.

දැන්, අදහස් භාවිතා කිරීමට වඩාත්ම කැපී පෙනෙන හේතුව වන්නේ කේතය තේරුම් ගැනීමට පහසු වන අතර, අදහස් නොමැති වීම ගැන මිනිසුන් මැසිවිලි නගන විට, ඔවුන් එක්කෝ හෝඩුවාවක් නැති ගිරවුන් හෝ ඔවුන් සමඟ වැඩ කරන කේතය තේරුම් ගැනීමට අපහසු වේ.

එබැවින් නැතිවූ අදහස් ගැන පැමිණිලි නොකරන්න: කියවිය නොහැකි කේතය ගැන පැමිණිලි කරන්න. හෝ වඩා හොඳ තවමත්, පැමිණිලි නොකරන්න, කේතය ගැන දිගටම ප්‍රශ්න අසන්න. ඔබට නොතේරෙන ඕනෑම දෙයක් සඳහා, එය ලියූ පුද්ගලයාගෙන් විමසන්න. ඔබ එය කෙසේ හෝ කළ යුතුය; කියවිය නොහැකි කේතය සමඟ, ඔබ තවත් ප්‍රශ්න අසනු ඇත. ඔබ පසුව කේත කැබැල්ලකට නැවත පැමිණ, එය කරන්නේ කුමක්දැයි ඔබට නිවැරදිව මතක ඇති බව ඔබට විශ්වාස නැත්නම්, එම ප්‍රශ්නයම නැවත අසන්න.

අදහස් දැක්වීමට එය නිවැරදි කළ හැකි නම් සහ ඔබේ සගයාට ක්‍රියාකාරී මොළයක් තිබේ නම්, ඔහු / ඇය යම් අවස්ථාවක දී තේරුම් ගනීවි, ඔබ නිතරම මෝඩ ප්‍රශ්න ඇසීමට වඩා කේතය අදහස් දැක්වීම වඩා පහසු බව. ඔබට ප්‍රශ්න ඇසීමට නොහැකි නම්, සමහර විට එම කේතය දැනටමත් හොඳින් කියවිය හැකි අතර, ඔබම වැරැදි කර ඇත්තේ ඔබමයි - සියල්ලට පසු, සියලු කේත වලට අදහස් අවශ්‍ය නොවේ.

මිනිසුන්ගේ කුසලතා ඉදිරියේ, අඩු වියදමකින් හෝ චෝදනා කිරීමෙන් වළකින්න; ඔබේ ප්‍රශ්න ගැන බැරෑරුම් හා අවංක වන්න.

ස්වයං ලේඛන කේතයක් හෝ ප්‍රයෝජනවත් අදහස් ලිවීමේදී කරදර ඇති බොහෝ දේව්වරුන් මට හමු වී ඇත. මේ ආකාරයේ පුද්ගලයින්ට බොහෝ විට එය නිවැරදිව කිරීමට තරම් ස්වයං විනයක් හෝ පළපුරුද්දක් නොමැත.

කිසි විටෙකත් ක්‍රියා නොකරන දෙය නම්, “තවත් අදහස් එක් කිරීමට ඔවුන්ට පැවසීම” යන්නයි. මෙය ඔවුන්ගේ ස්වයං විනය හෝ අත්දැකීම් වැඩි නොකරනු ඇත. IMHO වැඩ කළ හැකි එකම දෙය වන්නේ නිතර කේත-සමාලෝචන සහ ප්‍රතිනිර්මාණය කිරීමේ සැසි කිරීමයි. Dev විසින් යම් කාර්යයක් සම්පූර්ණ කළ විට, ඔබට නොතේරෙන කේතයේ ඕනෑම කොටසක් පැහැදිලි කිරීමට ඔහුට / ඇයට ඉඩ දෙන්න. මාස 6 කට පසුව ඔබ දෙදෙනාට තේරුම් ගත හැකි වන පරිදි කේතය වහාම ප්‍රතිනිර්මාණය කරන්න හෝ ලේඛනගත කරන්න.

මාස කිහිපයක්, අවම වශයෙන් සතියකට දෙවරක්වත් මෙය කරන්න. ඔබ ප්‍රමාණවත් තරම් වාසනාවන්ත නම්, සමාලෝචන සංඛ්‍යාතය අඩු කර ගත හැකි වන පරිදි අනෙක් සැසිවාරයන් මෙම සැසි හරහා ඉගෙන ගනු ඇත.

කිසිවෙකු තවමත් කේත සමාලෝචන සඳහන් නොකිරීම මට පුදුමයකි. කේත සමාලෝචන කරන්න! ඔහුට නරක තත්ත්වයේ චෙක්පතක් ඇති විට "අදහස් එකතු කරන්න" යැයි නොකියන්න. නිරන්තරයෙන් ප්‍රශ්න අසන්න සහ ඔහුගේ කේතය කරන්නේ කුමක්ද සහ ඇයි කියා ඔබට කියන්න. සටහන් ගන්න. කේත සමාලෝචනය අවසානයේ ඔහුට සටහන් වල පිටපතක් ලබා දී ඔබේ ප්‍රශ්න තරමක් පැහැදිලිව පෙනෙන ලෙස ඔහුට කියන්න. එක්කෝ වැඩි අදහස් දැක්වීමකින් හෝ ඔහුගේ කේතය වඩා හොඳ තත්ත්වයේ කිරීම සඳහා ප්‍රතිනිර්මාණය කිරීමෙන් (හැකි විට දෙවැන්න)

මෙය ඔබගේ කණ්ඩායම් සේවකයා නිපදවන කේතය මත රඳා පවතී. බොබ් මාමාගේ පිරිසිදු කේත පොත ඔබ කියවන්නේ නම්, කේතයට අදහස් එකතු නොකිරීමට ඔහු සැබවින්ම කැමති බව ඔබට පෙනී යනු ඇත . කේතය එය කියවිය හැකි තරම් කියවිය හැකි නම්, අදහස් දැක්වීමේ අවශ්‍යතාවයක් නැති තරම්ය.

එය එසේ නොවේ නම්, හෝ සාකච්ඡා කළ නොහැකි යම් ප්‍රතිපත්තියක් නිසා ඔබට අදහස් අවශ්‍ය නම්, ප්‍රධාන ප්‍රශ්නය වන්නේ ඔහු / ඇය අදහස් ලිවීමට කැමති ඔබ පමණක් ද , නැතහොත් එය සමස්ත කණ්ඩායම හෝ කණ්ඩායම / ව්‍යාපෘතිය ද යන්නයි. නායක. එය ඔබ පමණක් නම්, එය එතරම් විශාල ගනුදෙනුවක් නොවන්නේ මන්දැයි සොයා ගැනීමට ඔබ ඔබේ අනෙක් සගයන් සමඟ කතා කළ යුතුය.

ව්‍යාපෘති නායකයාට අදහස් නොමැති නම් ඔබට ඒවා සම්පූර්ණ කිරීමේ කොටසක් ලෙස ඉල්ලා සිටිය හැකිය , එනම් ඉදිරිපත් කළ කේතයේ අදහස් නොමැති නම් වැඩ තවමත් අවසන් නැත. ඔහුගේ වර්තමාන කටයුතු අවසන් වන තුරු සහ ඒ සඳහා අදහස් දැක්වීම අවශ්‍ය වන තෙක් ඔහු වෙනත් වැඩ දිගටම කරගෙන නොයනු ඇත. කෙසේ වෙතත්, මේ ආකාරයේ බල කිරීම බොහෝ විට බිහිසුණු අදහස් දැක්වීමට හේතු වන බව මතක තබා ගන්න (කේත-අදහස් විකාරරූපී පුනරාවර්තනයක් බලාපොරොත්තු වන්න).

මගේ නිහතමානී මතයේ ඇති එකම ශක්‍ය ක්‍රමය නම් ඔබ සහ අනෙක් සියල්ලන් අදහස් දැක්වීම් වලින් ලබා ගන්නා සැබෑ ලාභය සාකච්ඡා කිරීමයි. හුදු සාකච්ඡාවකින් ඔහු / ඔහු එය තේරුම් නොගන්නේ නම්, සෑම විටම දුෂ්කර ක්‍රමයක් ද ඇත: නව කේත ලිවීමට ඔවුන්ට ඉඩ දෙනවා වෙනුවට පවතින කේතයේ වැඩ කිරීමට ඔවුන්ට ඉඩ දෙන්න. හැකි නම් ඔබ ඒවා එකිනෙකට වෙනස් සේවා ක්ෂේත්‍ර දෙකක් සොයා ගත යුතුය - එකක් නිසි ප්‍රයෝජනවත් අදහස් සහ තවත් අදහස් නොමැති. වෙනත් කෙනෙකුගේ කියවිය නොහැකි විවරණ රහිත කේතය කියවීම ඔබේම වැඩකටයුතු පිළිබඳ ඇස් ඇරීමකි.

අප සියලු දෙනාම වරක් එහි ගොස් ඇති අතර, යම්කිසි මූලාශ්‍රයක මුල් කතුවරයා මෙතරම් අලස ලෙස වැඩ කිරීම ගැන කෝප විය. අප සෑම කෙනෙකුම එවැනි කතුවරයකු බව අතිරේක පරාවර්තනයකි, ඔබ කියවීමේ හැකියාව ගැන සැලකිලිමත් විය යුතු බව ඔබට වැටහෙනු ඇත - එබැවින් මෙම පරාවර්තනය ප්‍රවර්ධනය කිරීම සඳහා ප්‍රති results ල ඔබේ සගයා සමඟ සාකච්ඡා කිරීමට අමතක නොකරන්න.

ඔබට උපදෙස් පිළිපැදිය නොහැකි සේවකයෙකු සිටී නම්, ඔහුට තරවටු කරන්න, එය ඔහුගේ වෘත්තීය දියුණුවට උපකාරී නොවන බව පැහැදිලිය. කේතීකරණ ශෛලියේ අඛණ්ඩතාව කණ්ඩායමක් සඳහා ඉතා වැදගත් වන අතර අනෙක් සියල්ලන්ම අදහස් ලියන්නේ නම් සහ මෙය එසේ නොවේ නම් එය කේතීකරණ ශෛලියට හානියක් වනු ඇත.

එයින් කියැවෙන්නේ ඔබට ඔහුට උදව් කළ හැකි බවයි. මගේ අත්දැකීම් අනුව, අදහස් දැක්වීමට වැඩි කාලයක් ගතවන බවට යමෙකු විරෝධය දක්වන විට, වැනි මානසික බාධකයක් තිබේ…

1. ඔහු තම කේත / සැලසුම් තේරීම් ගැන ස්වයං දැනුවත්ව සිටින අතර ඒවා ගද්‍ය රචනා කිරීමට කැමති නැත. (කේත සමාලෝචන යමෙකුගේ ආත්ම විශ්වාසය බිඳ දැමීමට තරම් ආත්ම විශ්වාසයක් ඇති කිරීමට උපකාරී වේ.)
2. ඔහු ඉතා රේඛීයව වැඩ කරන අතර වැඩි යමක් සිතන්නේ නැත. අදහස් දැක්වීම වේදනාකාරී වන්නේ ඔහුගේ අභිප්‍රාය වෙනත් ආකාරයකින් රචනා කිරීම සඳහා ඔහු වැඩ කරන මතකයෙන් ලිවීමට ආසන්නව තිබූ කේතය මුදා හැරීමට ඔහුට බල කරන බැවිනි. (මෙය සත්‍ය නම්, ඔහුගේ කේතයේ ගුණාත්මකභාවය සඳහා අදහස් දැක්වීම ඉතා වැදගත් වේ.)
3. Comments තිහාසිකව මිනිසුන්ට ඔහුගේ අදහස් තේරෙන්නේ නැත.

අදහස් දැක්වීම් පරීක්ෂණ හා සමාන බව ක්‍රමලේඛකයෙකුට අවබෝධ කර ගැනීම වැදගත් ය: ඒවා අනාගත භාවිතය සඳහා පමණක් නොවේ - ඒවා ක්‍රමලේඛකයාටම ය. ඔහුගේ ප්‍රවේශය ගැන වෙනස් ලෙස සිතීමට ඔවුහු ඔහුට බල කරති.

මේ කිසිවක් CI, පරීක්ෂණ හෝ කේත සමාලෝචන සඳහා ආදේශකයක් නොවේ. එය කේතීකරණයේ බොහෝ තීරණාත්මක කොටස් වලින් එකක් පමණි, එනම් කේතය ලිවීම නොවේ.

කේත සමාලෝචන මෘදුකාංග ලබාගෙන එය හොඳින් භාවිතා කරන්න.

අපි කිල්න් භාවිතා කරන අතර, අපි එයට කැමතියි. සෑම වෙනස් කිරීමක්ම සමාලෝචනය කළ යුතු ප්‍රතිපත්තියක් අප සතුව ඇත (ටැග් සහ ගැටුම්-අඩු ඒකාබද්ධ කිරීම් පිළිබඳ සමාලෝචන ඉහළ නැංවීමට / අනුමත කිරීමට අපි දේව්වරුන්ට ඉඩ දුන්නද (අපගෙන් බොහෝ දෙනෙක් රීබයිසිෆ් භාවිතා කළද); මේ ආකාරයෙන් සමාලෝචන නොමැතිව වෙනස්වීම් ඉක්මනින් හඳුනාගත හැකිය).

පැහැදිලි නොවන කේතය කේත සමාලෝචනයක් ප්‍රතික්ෂේප කිරීමට හේතුවකි. නිවැරදි කිරීම අදහස් හෝ පැහැදිලි කේතයක්ද යන්න ගැටළුවක් නොවේ, නමුත් සමාලෝචකයාට එය තේරුම් ගැනීමට හැකි විය යුතුය. සමහර devs කේතය නැවත ලිවීමට කැමැත්තක් දක්වයි, නමුත් අනෙක් අය (මා ඇතුළත් කර ඇත) බොහෝ විට අදහස් දැක්වීමේ අභිප්‍රාය ප්‍රකාශ කිරීම පහසු වේ (කේතයට එය කරන දේ පහසුවෙන් පෙන්විය හැකි නමුත් එය කළ යුතු දේ පෙන්වීම දුෂ්කර ය ).

කේතයේ පැහැදිලිකම පිළිබඳව කිසියම් ප්‍රශ්නයක් ඇත්නම්, සමාලෝචකයා සැමවිටම ජය ගනී. ඇත්ත වශයෙන්ම කතුවරයා එය තේරුම් ගෙන ඇත්තේ ඔවුන් එය ලියා ඇති බැවිනි. එය වෙනත් පුද්ගලයෙකුට පැහැදිලි විය යුතුය.

කිල්න් වැනි මෘදුකාංග භාවිතා කිරීමෙන් කිසිදු වෙනසක් නොසලකා හරිනු නොලැබේ. මගේ dev කණ්ඩායමේ සිටින සෑම කෙනෙක්ම මේ ආකාරයට වැඩි කැමැත්තක් දක්වයි. කේත සමාලෝචන මෘදුකාංගය අපගේ කේතයේ ගුණාත්මකභාවය සහ යෙදුම්වල ගුණාත්මකභාවය යන දෙකටම විශාල බලපෑමක් කර ඇත :-)

පළමු වරට මෘදුකාංගය හඳුන්වා දීමේදී ප්‍රතික්ෂේප කළ සමාලෝචන සමඟ ඩිව්ස් ආරක්ෂා වීම පහසුය, නමුත් මගේ අත්දැකීම් අනුව, මේ ආකාරයෙන් දේවල් වඩා හොඳ බව වටහාගෙන එය වැලඳ ගැනීමට ඔවුන්ට වැඩි කාලයක් ගත නොවේ :-)

සංස්කරණය කරන්න: එසේම සඳහන් කිරීම වටී, ඩිව්ස් ගුප්ත කේතය වාචිකව හෝ සමාලෝචනයේදී අදහස් දැක්වීමට ඉඩ නොදීමට අපි උත්සාහ කරමු. යමක් පැහැදිලි නැතිනම්, එය පැහැදිලි කිරීමට හොඳම ස්ථානය කේතයේ ඇත (අදහස් දැක්වීමේදී හෝ ප්‍රතිනිර්මාණය කිරීමෙන්), ඉන්පසු නව වෙනස් කිරීම් එකම සමාලෝචනයට එක් කරන්න.

ස්වාභාවික භාෂාවට අදාළ වන පරිදි කියවීමේ හැකියාව මනිනු ලබන්නේ කියවීමේ වේගය සහ අවබෝධය අනුව ය. සරල රීතියක් අනුගමනය කළ හැකි යැයි මම සිතමි, විශේෂිත කේත විවරණයක් මඟින් මෙම දේපල වැඩි දියුණු නොකළහොත් එය වළක්වා ගත හැකිය .

අදහස් දැක්විය යුත්තේ ඇයි?

කේත විවරණය කාවැද්දූ ලියකියවිලි ආකාරයක් වුවද, භාෂාවේම අංග භාවිතා කරමින් අතිරික්ත “ඕනෑවට වඩා ලේඛනගත” වැඩසටහන් (අර්ථවත් කේත) වළක්වා ගැනීම සඳහා ඉහළ මට්ටමේ ක්‍රමලේඛන භාෂාවල විවිධ ක්‍රම තිබේ. ක්‍රමලේඛන පෙළ පොතෙන් කේත ලැයිස්තුගත කිරීම නරක අදහසකි, එහිදී තනි ප්‍රකාශයන් වචනාර්ථයෙන් පාහේ තාත්වික ආකාරයෙන් පැහැදිලි කර ඇත (දැනටමත් ලබා දී ඇති පිළිතුරු වල "/ * වැඩි කිරීම 1 * /" උදාහරණය මතක තබා ගන්න), එවැනි අදහස් අදාළ කර ගැනීම. භාෂාව පිළිබඳ අද්දැකීම් අඩු වැඩසටහන්කරුවන්ට පමණි.

එසේ වුවද, සැබවින්ම “සියලු නපුරේ උල්පත” වන “අඩු ලේඛනගත” (නමුත් අර්ථ විරහිත) කේතය අදහස් දැක්වීමට උත්සාහ කිරීම එහි අරමුණයි. “ලේඛනගත නොවූ” කේතයේ පැවැත්ම නරක සං signal ාවකි - එක්කෝ එය ව්‍යුහගත නොවූ අවුලක් හෝ අද්භූත නැතිවූ අරමුණෙහි විකාරයකි. නිසැකවම, එවැනි කේතයක වටිනාකම අවම වශයෙන් සැක සහිත ය. අවාසනාවකට සෑම විටම උදාහරණ ඇත, නව සබ්මැරීනයකට ඔතා තැබීමට වඩා (දෘශ්‍යමය වශයෙන්) ආකෘතිගත කරන ලද කේත රේඛාවල කොටසකට විවරණයක් හඳුන්වා දීම වඩා හොඳ වන විට (“කුඩා මනසෙහි විනෝදාංශය වන“ මෝඩ අනුකූලතාව ”මතක තබා ගන්න) .

කේත කියවීමේ හැකියාව! = කේත අදහස්

කියවිය හැකි කේතයට අදහස් දැක්වීම් මගින් විවරණ අවශ්‍ය නොවේ. කේතයේ සෑම විශේෂිත ස්ථානයකම මෙම විශේෂිත කේතය සාක්ෂාත් කරගත යුතු කාර්යයක සන්දර්භය සෑම විටම පවතී. අරමුණ නැතිවී ඇත්නම් සහ / හෝ කේතය අද්භූත යමක් කරන්නේ නම් = එය ඕනෑම වියදමකින් වළකින්න. ඔබේ කේතය ජනගහනය කිරීමට අමුතු හක්කවලට ඉඩ නොදෙන්න - එය පදනම් තේරුම් ගැනීමට කාලය / උනන්දුව නොමැති දෝෂ සහිත තාක්ෂණයන් ඒකාබද්ධ කිරීමේ result ජු ප්‍රති result ලයකි. ඔබේ ව්යාපෘතියේ ගුප්ත කේතය මග හරින්න!

අනෙක් අතට, කියවිය හැකි වැඩසටහන = කේත + ප්‍රලේඛනය තුළ නීත්‍යානුකූල අදහස් කිහිපයක් අඩංගු විය හැකිය, උදා: “API වෙත අදහස් දැක්වීම්” ප්‍රලේඛනය උත්පාදනය කිරීමට පහසුකම් සැලසීම.

කේත ශෛලියේ ප්‍රමිතීන් අනුගමනය කරන්න

හාස්‍යජනක ප්‍රශ්නය වන්නේ කේතය අදහස් දැක්වීමට හේතුව ගැන නොවේ, එය කණ්ඩායම් වැඩ කිරීම ගැන ය - ඉහළ සමමුහුර්ත ශෛලියකින් කේත නිෂ්පාදනය කරන්නේ කෙසේද (අනෙක් සියල්ලන්ට කියවීමට / තේරුම් ගැනීමට හැකි). ඔබ ඔබේ සමාගමේ කේත ශෛලියේ ප්‍රමිතීන් අනුගමනය කරනවාද? එහි ප්‍රධාන පරමාර්ථය වන්නේ ප්‍රතිනිර්මාණය කිරීම අවශ්‍ය වන කේත ලිවීමෙන් වැළකී සිටීම, එය “පුද්ගලික” සහ “විෂයානුබද්ධ” අපැහැදිලි ය. එබැවින් මම සිතන්නේ, යමෙකු ශෛලිය භාවිතා කිරීමේ අවශ්‍යතාවය දුටුවහොත්, එය නිසි ලෙස ක්‍රියාත්මක කරන්නේ කෙසේද යන්න පිළිබඳ බරපතල මෙවලම් තිබේ - මිනිසුන් දැනුවත් කිරීම ආරම්භ කිරීම සහ කේතයේ ගුණාත්මක පාලනය සඳහා ස්වයංක්‍රීයකරණයෙන් අවසන් වීම (බොහෝ ලින්ට් ආදිය) සහ (සංශෝධනය) පාලන ඒකාබද්ධ) කේත සමාලෝචන පද්ධති.

කේත කියවීමේ හැකියාව එවැන්ජලිස්තවරයෙකු වන්න

කේතය ලිවීමට වඩා බොහෝ විට කියවන බව ඔබ එකඟ වන්නේ නම්. අදහස් ප්‍රකාශ කිරීම සහ සිතීම පැහැදිලිව ඔබට වැදගත් නම්, සන්නිවේදනය සඳහා කුමන භාෂාව භාවිතා කළත් (ගණිතය, යන්ත්‍ර කේතය හෝ පැරණි ඉංග්‍රීසි) .. ඔබේ මෙහෙවර නම් විකල්ප චින්තනයේ අඳුරු හා කැත ක්‍රමය තුරන් කිරීමයි .. (සමාවෙන්න , අන්තිම එක වෙනත් "මැනිෆෙස්ට්" එකකින්) .. ප්‍රශ්න ඇසීම, සාකච්ඡා ආරම්භ කිරීම, කේත පිරිසිදු කිරීම පිළිබඳ සිතුවිලි අවුස්සන පොත් පතුරුවා හැරීම (බොහෝ විට බෙක්ගේ සැලසුම් රටාවන්ට සමාන දෙයක් පමණක් නොව, ආර්.සී. මාටින් විසින් දැනටමත් සඳහන් කර ඇති පරිදි ) අපැහැදිලි බව ආමන්ත්‍රණය කරයි. වැඩසටහන්කරණයේදී. තව දුරටත් ප්‍රධාන අදහස්වල වෙඩි නොවදින ඡේදයක් (කියවීමේ හැකියාව පිළිබඳ ඕ'රෙයිලි පොතෙන් උපුටා දක්වා ඇත)

• සෑම කේත පේළියකටම අදාළ වන ඉඟි සමඟ නම් කිරීම, අදහස් දැක්වීම සහ හැඩතල ගැන්වීම සරල කරන්න
• සංකීර්ණත්වය සහ ව්‍යාකූලත්වය අවම කිරීම සඳහා ඔබේ වැඩසටහනේ ලූප, තර්කනය සහ විචල්‍යයන් පිරිපහදු කරන්න
• වරකට එක් කාර්යයක් කිරීම සඳහා කේත කුට්ටි ප්‍රතිසංවිධානය කිරීම වැනි ක්‍රියාකාරී මට්ටමේ ගැටළු වලට පහර දෙන්න
• පරිපූර්ණ හා සංක්ෂිප්ත මෙන්ම කියවිය හැකි effective ලදායී පරීක්ෂණ කේතයක් ලියන්න

"අදහස් දැක්වීම" කපා හැරීම, එකක් තවමත් බොහෝ දේ ඉතිරිව ඇත ( අදහස් දැක්වීමට අවශ්‍ය නොවන කේත ලිවීම විශිෂ්ට ව්‍යායාමයක එක් අංගයක් යැයි මම සිතමි !). අර්ථාන්විත අර්ථකථන නම් කිරීම හොඳ ආරම්භයකි. ඊළඟට, තාර්කිකව සම්බන්ධිත ක්‍රියාකාරකම් ශ්‍රිත හා පන්ති වලට කාණ්ඩ කිරීමෙන් ඔබේ කේතය ව්‍යුහගත කිරීම. සහ යනාදි. වඩා හොඳ ක්‍රමලේඛකයෙක් වඩා හොඳ ලේඛකයෙකි (ඇත්ත වශයෙන්ම, ලබා දී ඇති වෙනත් තාක්ෂණික කුසලතා උපකල්පනය කරයි).

කේත විවරණ කෙරෙහි අවධානය යොමු කිරීම මා වැරදිද? නැතහොත් මෙය විසඳිය යුතු විශාල ගැටලුවක් පෙන්නුම් කරනවාද?

තරමක්. නියම කේතයට අදහස් අවශ්‍ය නොවේ. කෙසේ වෙතත් ඔබ කී පරිදි, ඔහුගේ කේතය ස්වයං ලේඛනගත කිරීමක් නොවේ. එබැවින් මම අදහස් දැක්වීම් කෙරෙහි අවධානය යොමු නොකරමි. ඔබේ සංවර්ධකයින්ගේ කුසලතා සහ ශිල්පීය හැකියාවන් වැඩි දියුණු කිරීම කෙරෙහි ඔබ අවධානය යොමු කළ යුතුය.

ඉතින් එය කරන්නේ කෙසේද? සමාලෝචන / ප්‍රතිනිර්මාණය කිරීමේ සැසි පිළිබඳ ඩොක් බ්‍රවුන්ගේ යෝජනා හොඳ අදහසකි. යුගල වැඩසටහන්කරණය වඩාත් effective ලදායී බව මට පෙනේ, නමුත් එය ක්‍රියාත්මක කිරීම සැලකිය යුතු ලෙස දුෂ්කර විය හැකිය.

පළමුවෙන්ම, අදහස් දැක්වීම පිළිබඳ ඔබේ ප්‍රවේශය නැවත ආමන්ත්‍රණය කිරීමට මම ඔබට යෝජනා කරමි.

ඒවා API මට්ටමින් ලියකියවිලි අදහස් නම් (පසුව මහජනයාට නිරාවරණය වේ), එවිට මෙම සංවර්ධකයා හුදෙක් ඔහුගේ කාර්යය නොකරයි. නමුත් අනෙක් සියලුම අදහස් සඳහා ප්‍රවේශම් වන්න.

මට හමු වූ බොහෝ අවස්ථාවන්හිදී අදහස් දැක්වීම නපුරු ය. රොබට් මාටින් විසින් රචිත "පිරිසිදු කේතය" හි කේත විවරණ පරිච්ඡේදය කියවීමට මම නිර්දේශ කරමි .

අදහස් ඔබගේ කේතයට ක්‍රම කිහිපයකින් රිදවයි:

1) ඒවා නඩත්තු කිරීමට අපහසුය. ප්‍රතිචක්‍රීකරණය කිරීමේදී ඔබට අමතර වැඩක් කිරීමට සිදුවේ; ඔබ විවරණයේ විස්තර කර ඇති තර්කනය වෙනස් කරන්නේ නම්, ඔබ ද විවරණය සංස්කරණය කළ යුතුය.

2) ඔවුන් බොහෝ විට බොරු කියති. ඔබට අදහස් විශ්වාස කළ නොහැකි අතර ඒ වෙනුවට කේතය කියවිය යුතුය. එමඟින් ප්‍රශ්නය මතු වේ: ඔබට අදහස් දැක්වීම් කිසිසේත් අවශ්‍ය වන්නේ ඇයි?

// this method returns the sum of 'a' and 'b'
public int GetHash(int a, int b)
{
    //the calculation of the hash
    int result = a*b;
}

(හැෂ් යනු එකතුව නොව නිෂ්පාදිතයයි.)

3) අදහස් කේතය අවුල් කරන අතර ඉතා කලාතුරකින් ඕනෑම අගයක් එකතු කරයි.

මගේ විසඳුම: තවත් අදහස් එකතු කරනවා වෙනුවට ඒවායින් මිදීමට උත්සාහ කරන්න!

කණ්ඩායම් සාමාජිකයෙකුට වෙනත් කණ්ඩායම් සාමාජිකයෙකුගේ කේතයක් තේරුම් ගැනීමට අපහසු නම් (ඕනෑම හේතුවක් නිසා); එවිට එම කණ්ඩායම් සාමාජිකයාට මුල් කේතය ලිව්වේ කවුරුන්දැයි සොයා ගැනීමට හැකි විය යුතුය (ඕනෑම සංශෝධන පාලන පද්ධතියක්) සහ එය කෙලින්ම පැහැදිලි කරන ලෙස කේතයේ කතුවරයාගෙන් ඉල්ලා සිටීමට දිරිමත් කළ යුතුය (උදා: ඔවුන්ගේ මේසය වෙත ඇවිදින්න, වාඩි වී සාකච්ඡා කරන්න).

මෙම අවස්ථාවේ දී, අදහස් නොමැතිකම ගැටළුවක් නම්, ඔවුන්ගේ කේතය ප්‍රමාණවත් ලෙස අදහස් නොදක්වන පුද්ගලයා ඔවුන් කළ දේ පැහැදිලි කිරීමට විශාල කාලයක් වැය කරනු ඇත; සහ (ඔවුන් බුද්ධිමත් නම්) එම සියලු පැහැදිලි කිරීම් සඳහා කාලය වැය නොකිරීමට අදහස් එකතු කිරීම ආරම්භ කරයි.

කණ්ඩායම් සාමාජිකයන් එකිනෙකාගෙන් පැහැදිලි කිරීම් ඉල්ලා සිටීම දිරිමත් කිරීම වෙනත් හේතු නිසා වටිනා බව සලකන්න. උදාහරණයක් ලෙස, සමහර විට කණ්ඩායම් සාමාජිකයෙකු අඩු පළපුරුද්දක් ඇති අතර වඩා පළපුරුදු කණ්ඩායම් සාමාජිකයන්ගෙන් දේවල් ඉගෙන ගත හැකිය.

බොහෝ දුරට, කණ්ඩායම් සාමාජිකයින් එකිනෙකාගෙන් පැහැදිලි කිරීම් ඉල්ලා සිටීමට උනන්දු කිරීමෙන් ඔබ ස්වයං සමතුලිත පද්ධතියක් නිර්මාණය කරයි; එහිදී විවිධ කණ්ඩායම් සාමාජිකයන් එකිනෙකාට ස්වයංක්‍රීයව හැඩගැසෙයි.

මෙය බොහෝ දුරට tdammers පිළිතුරේ දිගුවකි, නමුත් නියමිත වේලාවට කේත සමාලෝචන සිදු කරන්න.

ඔහු (සහ අනෙකුත් සංවර්ධකයින්) වාඩි වී සිටීම, ඔවුන්ගේ කේතය හරහා ගමන් කිරීම සහ ඔවුන්ගේ ඉහළ නිලධාරීන් හා සම වයසේ මිතුරන් ඉදිරියේ වැඩි හෝ අඩු ආරක්ෂාවක් ලබා දීම සෑම කෙනෙකුටම වඩා හොඳ කේත රචකයන් බවට පත් කරනු ඇති අතර සාපේක්ෂව කෙටි කාලයක් තුළ සැබෑ වටිනාකමක් එක් කරනු ඇත. කෙටිකාලීනව, එය සමාලෝචනයේදී, ඔහුගේ කේතය නිසි ලෙස අදහස් දැක්වීමට කිසිදු නිදහසට කරුණක් සංවර්ධකයාට ලබා දෙනු ඇත.

සංස්කරණය කරන්න: කවුරුහරි මගේ යෝජනාව අවතක්සේරු කරන්නේ මන්දැයි මට විශ්වාස නැත - සමහර විට කේත සමාලෝචනයේ ප්‍රතිලාභ පොදු දැනුමක් වනු ඇතැයි මම සිතමි ... කරුණාකර මෙම නූල බලන්න භාවිතයේ ප්‍රජා විශ්ලේෂණයක් ලෙස:

කේත සමාලෝචනය හොඳ භාවිතයක්ද?

අදහස් දැක්වීම පිළිබඳ බොහෝ විට ආන්තික අදහස් සලකා බැලීමේදී, මම බර කිරා බැලීමට අදිමදි කරමි.

ඔබ (කියවිය නොහැකි) කේතයක් ලිවීමට යන්නේ නම් එය නිසි ලෙස ලේඛනගත කළ යුතු යැයි මට ඉදිරිපත් කළ හැකි තර්ක මොනවාද?

නඩත්තු කළ හැකි සහ කියවිය හැකි කේතයක් ලිවිය යුතු ආකාරය තේරුම් ගැනීමට කාලය, පුහුණුව සහ අත්දැකීම් අවශ්‍ය වේ. අද්දැකීම් අඩු ක්‍රමලේඛකයින් (හා කනගාටුදායක ලෙස බොහෝ පළපුරුදු අය) බොහෝ විට Ikea Effect ( PDF ) වලින් පීඩා විඳිති . එයට හේතුව ඔවුන් එය ගොඩනඟා ඇති අතර ඒ පිළිබඳව සමීපව හුරුපුරුදු වන අතර කේතය විශිෂ්ට පමණක් නොව කියවිය හැකි බව ඔවුන්ට විශ්වාසයි.

පුද්ගලයා විශිෂ්ට ක්‍රමලේඛකයෙක් නම්, යම් ලියකියවිලි අවශ්‍ය නම් අල්පය. කෙසේ වෙතත්, බොහෝ ක්‍රමලේඛකයින් විශිෂ්ට නොවන අතර ඔවුන්ගේ කේත බොහොමයක් "කියවීමේ හැකියාව" දෙපාර්තමේන්තුවේ දුක් විඳිනු ඇත. "ඔවුන්ගේ කේතය පැහැදිලි කිරීම" සඳහා මධ්‍යස්ථ හෝ සංවර්ධනය කරන ක්‍රමලේඛකයාගෙන් ඉල්ලා සිටීම ප්‍රයෝජනවත් වන අතර එමඟින් ඔවුන්ගේ කේතය වඩාත් විවේචනාත්මක ඇසකින් බැලීමට බල කරයි.

මෙයින් අදහස් කරන්නේ ඔවුන්ගේ කේතය "ලේඛනගත කිරීම" ද? අවශ්‍ය නොවේ. උදාහරණයක් ලෙස, අතීතයේ දී මෙම ගැටලුව සමඟ මට සමාන ක්‍රමලේඛකයෙකු සිටියේය. මම ඔහුට ලේඛනගත කිරීමට බල කළා. අවාසනාවට ඔහුගේ ලියකියවිලි ඔහුගේ කේතය තරම්ම විස්තර කළ නොහැකි වූ අතර කිසිවක් එකතු කළේ නැත. නැවත සලකා බැලීමේදී කේත සමාලෝචන වඩාත් ප්‍රයෝජනවත් වනු ඇත.

ඔබ (හෝ නියෝජිතයෙකු) මෙම ක්‍රමලේඛකයා සමඟ වාඩි වී ඔහුගේ පැරණි කේත කිහිපයක් ඇද ගත යුතුය. ඔහු දන්නා අලුත් දේවල් නොවේ. අවම අන්තර්ක්‍රියාකාරිත්වයකින් ඔහුගේ කේතය හරහා ඔබව ගෙන යන ලෙස ඔබ ඔහුගෙන් ඉල්ලා සිටිය යුතුය. මෙය වෙනම "ලේඛනගත කිරීමේ" සැසියක් ද විය හැකිය, එහිදී ඔහු තම කේතය ලිවීමේදී පැහැදිලි කළ යුතුය. එවිට ඔහු වඩා හොඳ ප්‍රවේශයන් පිළිබඳව ප්‍රතිපෝෂණය ලබා ගත යුතුය.

අනෙක් අතට ... කේතයේ "කියවීමේ හැකියාව" කොතරම් හොඳ වුවත් සමහර ලියකියවිලි අවශ්‍ය වේ. ඒපීඅයි හි ලියකියවිලි තිබිය යුතුය, අතිශයින්ම තාක්‍ෂණික හා සංකීර්ණ මෙහෙයුම් වලට සම්බන්ධ ක්‍රියාදාමයන් අවබෝධ කර ගැනීම සඳහා ක්‍රමලේඛකයාට උපකාර කිරීම සඳහා ලියකියවිලි තිබිය යුතුය (බොහෝ විට ක්‍රමලේඛකයින්ගේ දැනුමේ වසමෙන් පිටත), සහ සංකීර්ණ රීජෙක්ස් වැනි සමහර දේ ඔබ ගැලපෙන දේ ලේඛනගත කළ යුතුය.

බොහෝ ව්‍යාපෘති සඳහා කේත ලේඛන අවශ්‍ය වේ: අතුරු මුහුණත් ලේඛනය, සැලසුම් ලේඛනය, ...

සමහර ව්‍යාපෘති සඳහා එවැනි ලියකියවිලි කේත විවරණවල තබා ඩොක්සිජන් හෝ ස්පින්ක්ස් හෝ ජාවඩොක් වැනි මෙවලම් සමඟ උපුටා ගත යුතුය, එවිට කේතය සහ ප්‍රලේඛනය වඩාත් ස්ථාවර වේ.

ඒ ආකාරයෙන්, සංවර්ධකයින්ට කේතයෙන් ප්‍රයෝජනවත් අදහස් ලිවීමට අවශ්‍ය වන අතර මෙම රාජකාරිය ව්‍යාපෘති සැලසුම් කිරීමේදී ඒකාබද්ධ වේ.

බොහෝ පිළිතුරු සහ අදහස් වලින් ඉඟි කර ඇති දේ මම සඳහන් කරන්නෙමි: ඔබ තේරුම් ගත් විසඳුම ඉදිරියට ගෙන යාමට උත්සාහ කරනවාට වඩා මෙහි ඇත්ත ප්‍රශ්නය ඔබ විසින් සොයාගත යුතුය.

ඔහුගේ කේතයේ අදහස් දැක්වීමට ඔබ පෙලඹී ඇත; ඇයි ? ඔබ හේතුවක් දුන්නා; ඇයි ඒ හේතුව ඔබට එතරම් වැදගත් වන්නේ ඇයි? ඒ වෙනුවට ඔහු වෙනත් දෙයක් කිරීමට පෙළඹේ; ඇයි ? ඔහු හේතුවක් දෙයි; ඇයි ඒ හේතුව ඔහුට එතරම් වැදගත් වන්නේ ඇයි? ගැටුම සැබවින්ම පැන නගින මට්ටමට ඔබ පැමිණෙන තෙක් මෙය නැවත සිදු කරන්න, ඔබ දෙදෙනාට ජීවත් විය හැකි විසඳුමක් සොයා ගැනීමට උත්සාහ කරන්න. අදහස් දැක්වීමට එතරම් සම්බන්ධයක් නැති බව මම ඔට්ටු තබමි.

ඔබ හොඳ කේතීකරණ ප්‍රමිතියක් අනුගමනය කරන්නේ නම්, අවම වශයෙන් අදහස් දැක්වීමක් අවශ්‍ය වේ. නම් කිරීමේ සම්මුතීන් වැදගත් ය. ක්‍රම නාම සහ විචල්‍ය නම් ඔවුන්ගේ කාර්යභාරය විස්තර කළ යුතුය ..

අඩු අදහස් දැක්වීමට මගේ ටීඑල් මට යෝජනා කරයි. ඔහුට අවශ්‍ය මගේ කේතය තේරුම් ගත හැකි සහ ස්වයං විස්තර සහිත විය යුතුය. සරල උදාහරණය: සෙවුම් රටාව සඳහා භාවිතා කරන නූල් වර්ගය සඳහා විචල්‍ය නම

   var str1:String="" //not uderstandable
   var strSearchPattern:String="" //uderstandable

කේත සමාලෝචන පිළිතුරු වලට ආදරය කරන්න, නමුත් සමහර විට මගේ ක්‍රියාවලිය මඳක් උපකාරී වනු ඇත.

මම අදහස් දැක්වීමට ප්‍රිය කරමි, නමුත් මම කිසි විටෙකත් පළමු පාස් එකේ කේතයට ඒවා එකතු නොකරමි. සමහර විට එය මගේ ශෛලිය පමණක් විය හැකි නමුත් සංවර්ධනයේදී මම 3 සිට 5 වතාවක් කේතයේ එකම කොටසට පහර දෙමි (ප්‍රතිනිර්මාණය, ලිවීමේ පරීක්ෂණ ආදිය).

මා තරමක් ව්‍යාකූල වූ විට හෝ කේතයේ කොටසක් ගැන යමෙකු මගෙන් ප්‍රශ්නයක් ඇසූ විට මම එය නිවැරදි කිරීමට උත්සාහ කරමි.

මෙය තමන්ගේම ක්‍රියාකාරිත්වයට ව්‍යාකූල මෙහෙයුම් සමූහයක් ඉවත් කිරීම සඳහා විවරණයක් එකතු කිරීම තරම් සරල විය හැකිය, නැතහොත් නව වස්තුවක් නිස්සාරණය කිරීම වැනි විශාල ප්‍රතික්‍රියාකාරකයක් අවුලුවන.

කණ්ඩායමේ සිටින සෑම කෙනෙකුටම ඔවුන්ගේ කේතය අන් අයට කියවිය හැකි යැයි "අයිති කර ගැනීමට" ඔබ දිරිමත් කරන ලෙස මම යෝජනා කරමි - මෙයින් අදහස් කරන්නේ ඔබේ කේතය ගැන යමෙකු ඔබෙන් ප්‍රශ්නයක් අසන සෑම අවස්ථාවකම ඔබ වෙනසක් කිරීමට කැපවී සිටින බවයි - නැතහොත් වඩා හොඳ නමුත් ඒ සමඟ යුගල කරන්න ඒ මොහොතේම වෙනසක් කිරීමට පුද්ගලයා!

ඔබගේ "කණ්ඩායම් කොන්ත්‍රාත්තුවේ" කොටසක් ලෙස මේ සඳහා බල කිරීම ගැන බැරෑරුම් ලෙස සලකා බලන්න (ඔබ සතුව එකක් නොමැති නම් නිශ්චිතවම කොන්ත්‍රාත්තුවක් සාදන්න) - ඒ ආකාරයෙන් සෑම දෙනාම එයට එකඟ වී ඇති අතර ඔබ එය කොහේ හෝ තැනක බිත්තියක් මත තබා ඇති අතර එමඟින් එය සිදු නොවේ. ඔබ කිරීමට එකඟ වූ දේ පිළිබඳ කිසියම් ප්‍රශ්නයක්.

සමහර විට මෙම පුද්ගලයාට හොඳ කේතීකරණ විනයක් පිළිබඳ ඇගයීමක් ලබා දිය යුතු අතර, ඔහු ලියා ඇති කේතය තේරුම් ගැනීමට අනෙක් අයට හැකි වන්නේ ඇයි?

මම මගේ වෘත්තිය තුළ සැබවින්ම භයානක කේත පදනම් කිහිපයක් මත වැඩ කර ඇත්තෙමි, කේතය එතරම් නරක ලෙස සංවිධානය වී ඇති, විචල්‍ය නම් එතරම් දුර්වල වූ අතර, අදහස් එතරම් නරක හෝ නොපවතින, කේත පදනම මගේ tivity ලදායිතාවයට හානි කළේය. ඔබට නොතේරෙන කේත පදනමක් නිවැරදි කිරීමට හෝ වැඩිදියුණු කිරීමට ඔබට වැඩ කළ නොහැකි අතර, එය නවකයන්ට නොපෙනෙන අයුරින් ලියා තිබේ නම්, ඔවුන් එය ඇත්ත වශයෙන්ම වැඩ කිරීමට වඩා එය තේරුම් ගැනීමට උත්සාහ කරයි.

කටුක අත්දැකීම් වලට වඩා හොඳ ගුරුවරයෙක් නැත!

සෑම කේත කඳවුරකම එහි බිහිසුණු බිටු කිහිපයක් තිබේ, පද්ධතියේ සමහර කොටස් ස්පර්ශ කිරීමට කිසිවෙකුට අවශ්‍ය නැත, මන්ද ඔවුන් යමක් බිඳීමට බිය වන නිසා හෝ ඔවුන්ට අර්ථවත් වැඩක් කළ නොහැක්කේ කේතය ලිවූ කවුරුන් හෝ දිගු කලක් ඉවත්ව ගොස් ඔවුන්ගේ අවබෝධය ලබාගෙන ඇති බැවිනි. ඔවුන් සමඟ කේතය. එම කේතය සංවර්‍ධනය නොවී ස්වයං ලේඛනගත කිරීමක් නොවේ නම් එය වඩාත් නරක අතට හැරේ.

මම යෝජනා කරන්නේ ඔබේ කෝඩ්බේස් එකෙන් ටිකක් සොයා ගෙන ඒ සඳහා ඔබේ කරදරකාරී කෝඩර් වගකීම ලබා දෙන්න. ඔහුට එහි හිමිකාරිත්වය ලබා දෙන්න, එය ඔහුගේ වගකීම බවට පත් කරන්න, නඩත්තු කළ නොහැකි කේතයක් මත වැඩ කිරීමේ සැබෑ වේදනාව ඉගෙන ගැනීමට ඔහුට ඉඩ දෙන්න, මන්ද එය නිසි ලෙස ලේඛනගත කර නොමැති නිසා හෝ කෙටි කාලයක් තුළ තේරුම් ගැනීමට නොහැකි බැවිනි. මාස කිහිපයක වැඩ කිරීමෙන් පසු, මට විශ්වාසයි ඔහු එන්නට පටන් ගනීවි.

අදහස් දැක්වීමකින් තොරව ඔහුට තවත් කේතයක් ලබා දී කේතය තේරුම් ගැනීමට ඔහුගෙන් ඉල්ලා සිටින්න. නිසි අදහස් දැක්වීමේ වැදගත්කම ඔහු තේරුම් ගනීවි.

මෙම ක්‍රමලේඛකයා යම් කේත නඩත්තු කිරීමක් කරයිද? එසේ නොවේ නම්, ඔහු කළ යුත්තේ: ඔබ අවට ඇති අකමැති ව්‍යාපෘතියක් පරීක්ෂා කර බලා එහි නඩත්තුව ඔහුට පවරන්න.

සාමාන්‍යයෙන් ඒවා නරක ලෙස ලේඛනගත කර ඇති ව්‍යාපෘති වන අතර, ඔබට නිවැරදි කිරීමට පහසු විය හැකි දේ නිවැරදි කිරීමට සිදුවන්නේ කුමක්ද යන්න තේරුම් ගැනීමට ඔබට පැය ගණනක් අහිමි වේ. මේ ආකාරයේ අත්දැකීම් ඔහුට යාවත්කාලීන වීමට අවශ්‍ය නොවන්නේ නම්, නිවැරදි හා ප්‍රයෝජනවත් ලියකියවිලි කිසිවක් සිදු නොවේ.

මගේ එක් අතීත ව්‍යාපෘතියක අදහස් දුසිම් ගණනක් (ඇල්ගොරිතම, ප්‍රති results ල හෝ මූලික ජාවාඩොක්) අතුරුදහන් විය, එබැවින් මම ඔහු වෙනුවෙන් ගැටළු 130 ක් කිරීමට තීරණය කළෙමි, සෑම දින 4 කට වරක්ම එක් එක් නිකුතුව පිළිබඳ විද්‍යුත් තැපැල් දැනුම් දීමක්. සති 3 කට පසු ඔහුට ගැටළු 280 ක් තිබූ අතර පසුව අදහස් දැක්වීමට ඔහු තීරණය කළේය.

අදහස් දැක්වීමට ඇත්තේ එක් අරමුණක් සහ එක් අරමුණක් පමණි:

මෙම කේතය මෙම ක්‍රියාව කරන්නේ ඇයි?

යම් දෙයක් එය එසේ වන්නේ මන්දැයි විවරණයකින් පැහැදිලි නොකරන්නේ නම් එය ඉවත් කළ යුතුය. කේතය අවුල් කරන නිෂ් less ල අදහස් නිෂ් less ල ඒවාට වඩා අඩුය, ඒවා ක්‍රියාකාරී ලෙස හානිකර වේ.

මගේ අදහස් මගේ IDE හි වඩාත්ම පැහැදිලිව ප්‍රකාශ කිරීමේ පුරුද්දක් ඇත. හරිත පසුබිමක සුදු පා text සමඟ ඒවා උද්දීපනය වේ. ඇත්තටම ඔබේ අවධානය යොමු කරන්න.

මෙයට හේතුව කේතය මඟින් යමක් කරන්නේ කුමක්ද යන්න පැහැදිලි කරන අතර අදහස් දැක්වීම් එය කරන්නේ ඇයිද යන්නයි . මට මෙය ප්‍රමාණවත් ලෙස අවධාරණය කළ නොහැක.

අදහස් දැක්වීමකට හොඳ උදාහරණයක්:

/* Must instantiate clsUser before trying to encrypt a password because the code to 
   encrypt passwords only uses strong encryption if that module is loaded. */

නරක උදාහරණයක්:

/* instantiate clsUser */

ඔබ කේතයේ "කොටස්" ලෙස අදහස් භාවිතා කරන්නේ නම්: ඔබේ දැවැන්ත ක්‍රමය කුඩා, ප්‍රයෝජනවත් නම් කරන ලද ශ්‍රිතවලට කපා අදහස් ඉවත් කරන්න.

ඊළඟ පේළියේ ඔබ කරන්නේ කුමක්දැයි ඔබ කියන්නේ නම්: කේතය ස්වයං පැහැදිලි කිරීමක් කර අදහස් දැක්වීම ඉවත් කරන්න.

ඔබ අදහස් අනතුරු ඇඟවීමේ පණිවිඩ ලෙස භාවිතා කරන්නේ නම්: එයට හේතුව ඔබ පවසන බවට වග බලා ගන්න.

මෙහි පිළිතුරු අතිරේකව සැපයීම සඳහා, "ඔබට එය නිවැරදිව කිරීමට අවශ්‍ය නම් එය ඔබ විසින්ම කළ යුතුය."

මම "ප්‍රධාන කේත විවරණකරු" වීම අදහස් නොකෙරේ, මම අදහස් කරන්නේ මෙම අනෙක් සංවර්ධකයා කුමක් කිරීමට ඔබ කැමතිද යන්න නිරූපණය කිරීමේ දී ආදර්ශයක් වීමයි. ඔවුන් පවසන්නේ පෙන්වීමට වඩා පෙන්වීම වඩා effective ලදායී බවයි. ගුණාත්මක අදහස් දැක්වීමේ වාසිය ඔබට නිරූපණය කළ හැකි නම් හෝ මෙම අනෙක් සංවර්ධකයාට උපදෙස් දීමට (ඔහු කැමති තාක් දුරට) ඔබට කේත අදහස් දැක්වීමේදී වැඩි සාර්ථකත්වයක් ලබා ගත හැකිය.

ඒ හා සමානව, ගෙදර දොරේ වැඩ කිහිපයක් තිබේ. කෙසේ වෙතත් එම වැඩ කටයුතු මගේ බිරිඳගේ "සුරතල් පීව්" වැඩ වේ ... ඇය සතුටින් සිටීම සඳහා කළ යුතු වැඩ . එකම තත්වය අනෙක් අතට අදාළ වේ. මෙම අනෙක් සංවර්ධකයා ඔබට වඩා වෙනස් ප්‍රමුඛතා ඇති බව ඔබ පිළිගත යුතු යැයි මම සිතමි, සෑම දෙයක් ගැනම ඔබ සමඟ එකඟ නොවනු ඇත. මගේ බිරිඳ සහ මම සොයාගෙන ඇති විසඳුම නම්, එම “සුරතල් සතුන්” සඳහා වන වැඩ සඳහා අප විසින්ම ඒවා කළ යුතු බවයි.

සරලයි: සේවකයා අදහස් දක්වන්නේ නැත්නම් shift+alt+j, කේතය ඇතුළත් කිරීමට සමගාමීව එක් එක් ක්‍රමයේදී ස්වයංක්‍රීයව අදහස් දැක්වීමට ඔහුට කියන්න . කරුණාකර මෙම ගැටළු මඟහරවා ගැනීම සඳහා කේත සංශෝධනය කරන්න.