کانال تلگرام

چه چیزی برنامه نویسان را در زمان نگاه کردن به کدهای شما خوشحال می کند؟

تاریخ : ۹ مرداد ۱۳۹۹
نویسنده : امیر حسین نصر
دسته بندی ها : برنامه نویسی

در طول زندگی حرفه ای برنامه نویسی، بیشتر زمانی که صرف میکنید مربوط به خواندن کد هاست تا اینکه بخواهید آنها را بنویسید. به گفته رابرت مارتین نسبت زمان صرف شده برای خواندن کد ها در مقابل نوشتن آنها چیزی بیش از نسبت ده به یک است.

از آن جایی که زمان زیادی را باید صرف خواندن کدها کنید، ممکن است با انواع مختلف کد ها روبرو باشید، از کدهایی که به سبک کاملاً تمیز نوشته شده‌اند و یا آنهایی که مثل ماکارونی در هم پیچیده اند. 

happyProgrammer

اما کدهای خود را باید به چه شکلی بنویسیم تا برنامه نویسانی که بعداً قرار است آنها را بررسی کنند، دچار مشکل نشوند؟

شاید همه ما ترجیح دهیم بدون هیچ قانونی کد نویسی کنیم اما این روش به شما در آینده ضربه خواهد زد. وقتی کد های خود را بر طبق قوانین موجود و به اصطلاح کاملاً تمیز می نویسید دیگران از شما تشکر خواهند کرد. در این مقاله به چهار شرطی خواهم پرداخت که در صورت رعایت آنها برنامه نویسان دیگر در زمان خواندن کدهای شما خوشحال خواهند بود.

سازگاری و انسجام

سازگاری یک کلید اساسی در برنامه نویسی است. برنامه هایی که به روشی منسجم و سازگار توسعه داده می شوند، نسبت به آنهایی که از از روشهای متفاوتی استفاده می کنند بسیار بهتر هستند. در واقع نگهداری و ویرایش اینگونه برنامه ها در آینده بسیار آسان تر خواهد بود.

استفاده از یک روش واحد در تمام بخش های یک نرم افزار باعث می شود کد شما از یک سبک مشابه پیروی کند. بنابراین برنامه نویسانی که کدهای شما را مورد بررسی قرار می‌دهند، با یادگیری بخش کوچکی از آنها می توانند نحوه عملکرد بخش های دیگر را نیز حدس بزنند.

یکی دیگر از مشکلات نرم‌افزارهایی که به روشی غیر سازگار تهیه می شوند، زمانی است که ممکن است از دست دهید. بیشتر اوقات اینگونه نرم افزار ها توسط افراد مختلفی نوشته می‌شوند والبته به همین دلیل است که ناسازگاری پیش می آید. بنابراین باید سعی کنید اعضای تیم خود را با یکدیگر هماهنگ کنید.

داشتن برنامه منسجم و سازگار در آینده به خصوص وقتی بخواهید برنامه را ویرایش کنید، بسیار اهمیت دارد. برای مثال  سعی کنید از یک روش مشخص برای نامگذاری متغیر ها در سراسر پروژه خود استفاده کنید، اگر یک روش را انتخاب کردید همه جا به آن پایبند باشید.

خوانایی

کد خوب دارای معیارهای خاصی است و البته خوانا بودن آن یکی از شرایط و معیارهای اولویت دار است. از آنجایی که احتمالاً شما تنها برنامه‌نویسی نیستید که روی یک پروژه کار می کنید، بنابراین کدهایی که می نویسید باید از خوانایی بالایی برخوردار باشند. در این صورت برنامه نویسان دیگر میتوانند به خوبی کدهای شما را درک کنند.

برنامه نویسی هنر فهماندن کاری به دیگران است که قرار است کامپیوتر آن را اجرا کند. اگر کد شما دارای چنین قابلیتی باشد از خوانایی خوبی برخوردار است. عبارت بالا بیان می کند که اهداف کد شما را باید دیگر برنامه نویسان به خوبی درک کنند.

حتی اگر شما تنها برنامه نویسی باشید که روی یک پروژه کار می کنید، احتمالاً یکسال بعد اهداف کد خود را به خوبی به یاد نخواهید آورد، پس باید کدهایی که می نویسید از خوانایی بالایی برخوردار باشند.

نوشتن کدهای خوانا از مهارت های اساسی هر برنامه نویسی است. برای بهبود خوانایی کد ها موارد زیادی وجود دارد که می توانید انجام دهید. یکی از راه هایی که می توانید کد خوانا تولید کنید، استفاده از تورفتگی هاست.

در صورت استفاده از این حاشیه ها کد های طولانی نیز قابل خواندن خواهند شد. از طرفی بهتراست کد شما از اصل مسئولیت واحد پیروی کند. این اصل بیان میکند که هر تابع یا بخشی از کد شما باید مسئولیت واحد داشته باشد. در نتیجه کدهای شما به بخش های کوچکتری تجزیه خواهند شد که خوانایی و درک آنها ساده‌تر است.

مستند سازی خوب کدها

یکی از مواردی که واقعاً برنامه‌نویسان را خوشحال میکند، مستند سازی خوب یک پروژه است. مستندات قابل اعتماد هنگام برنامه نویسی در یک پروژه جدید واقعاً ضروری و الزام آور است.

مستندات به بینش در مورد پروژه و پیگیری همه جوانب کار کمک خواهد کرد. این روش سریع ترین و آسان ترین راه برای انتقال دانش در مورد یک پروژه به دیگر برنامه نویسان است. به خصوص اگر برنامه‌نویسان تازه کاری بخواهند یک روی یک پروژه کار کنند، ارائه مستندات برای درک پروژه از اهمیت بالایی برخوردار است.

مستندات خوب تقریباً به اندازه نوشتن کدهای تمیز اهمیت دارد، در صورتی که لازم است در جاهای مختلف از کامنتها استفاده کنید، اگرچه یکی از اصول برنامه نویسی این است که کدهای شما باید تا جای ممکن خود توضیح دهنده کاری که انجام می‌دهند باشند، در نتیجه نیاز به کامنت ندارند، با این حال در برخی از جاها لازم است از کامنت ها هم استفاده کنید.

انجام تست های مختلف

تست ها چیزهایی هستند که وقتی وارد پروژه جدیدی می‌شوید لبخند بزرگی بر چهره هر برنامه‌نویس باقی میگذارند. همانطور که در یک پروژه کاملا ً غرق شده اید، اعمال تست ها روی پروژه از اهمیت بالایی برخوردار است.

با توجه به اینکه تشخیص تمام مشکلات یک پروژه از ابتدا غیرممکن است، تست‌ها به هر برنامه‌نویس نهایت اطمینان را می‌دهند. زمانی که شروع به تغییراتی کردید، یک راه مطمئن و ایمن برای چک کردن دارید، تا در جایی دیگر چیزی آسیب نبیند. متاسفانه برنامه نویسان تازه کار به دلیل اینکه از تست ها استفاده نمی کنند، از انجام تغییرات واهمه دارند.

تنها برنامه نویسان تازه کار از داشتن یک مجموعه تست قدرتمند بهره‌مند نمی‌شوند، بلکه کد ها هم این چنین هستند. زمانی که کد نویسی می کنید به وضعیتی خواهید رسید که نمی دانید چطور یک قطعه کد را تست کنید.

اگر در وضعیتی هستید که نمی دانید چطور کد های خود را آزمایش کنید بدانید کدهای شما بسیار پیچیده هستند، پس باید آنها را تغییر دهید تا ساده تر شوند، همین کار باعث افزایش خوانایی برنامه شما نیز خواهد شد. 

جمع بندی

نوشتن کدها به روشی سازگار و منسجم، مستند سازی خوب آن ها و پشتیبانی از تست ها همگی از جمله روشهای هستند که باعث میشود برنامه نویسان دیگر در زمان بررسی کدهای شما خوشحال باشند.

از طرفی تا جایی که می‌توانید کدهای بنویسید که از خوانایی بالایی برخوردار باشند. اصولی که در بالا بیان کردیم همگی در ارائه برنامه های قدرتمند برای شما از اهمیت بالایی برخوردار هستند، پس تلاش کنید تا جای ممکن آنها را رعایت کنید. 
 

اطلاعات مقاله


تاریخ انتشار : ۹ مرداد ۱۳۹۹
نویسنده : امیر حسین نصر
اشتراک گذاری در :

مقالات پیشنهادی

مشاهده همه مقالات
ثبت دیدگاه

برای ارسال دیدگاه لازم است ابتدا وارد سایت شوید