9 روش برای داشتن کد تمیز تر

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

بدون ديدگاه

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

کامنت گذاری

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

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

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

قواعد نام گذاری

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

  • camel Case یا کوهان شتری به این معنی که حرف اول به صورت کوچک نوشته می‌شود و کلمه دوم با حرف بزرگ شروع می‌شود برای مثال: myHome یا finalPrice
  •  Under Scrores در این روش بین کلمات آندرلاین (زیرخط) گذاشته می‌شود برای مثال: my_home یا final_price

کدها را تکرار نکنید

تکرار کدها باعث افزایش میزان حجم کدها خواهد شد. مثلا یک تابع ۱۰۰ خطی  را در نظر بگیرید که در تمام صفحات یک اپلیکیشن استفاده شده است. اگر بخواهید این تابع را در تمام صفحات تعریف کنید کد شما به میزان قابل توجهی افزایش پیدا خواهد کرد. یا هدر و فوتر یک وبسایت را در نظر بگیرید. هدر و فوتر در تمام صفحات یک وبسایت یکسان هستند. شما نیاز نیست هر دفعه هدر و فوتر را تعریف کنید. یکبار آن‌ها را تعریف می‌کنید و در هر صفحه به آن لینک می‌دهید. اگر به یک کد بیشتر از یکبار نیاز داشته باشید نیاز است تا آن را در قالب یک فایل جداگانه تعریف کنید و هنگام نیاز آن را فراخوانی کنید.

از نوشتن خط‌های طولانی کد بپرهیزید

نوشتن خط‌های طولانی کد، باعث می‌شود که خوانایی کد بسیار کم شود. همچنین باعث می‌شود تا درک اینکه چه کاری انجام می‌شود نیز بسیار کاهش یابد چون شما دائم مجبور به صورت افقی به جلو و عقب بروید (اسکرول افقی)

Task های بزرگ را به تکه‌های کوچک بشکنید

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

پروژه خود را به فایل‌های کوچک‌تر تقسیم کنید

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

کد هوشمندانه‌ای را بنویسید که قابل خواندن نیز باشد

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

کدها را اصلاح کنید

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

 

کدهای غیر ضروری را حذف کنید

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

 

نتیجه گیری

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

 

 

 

 

نوشتن دیدگاه

نشانی ایمیل شما منتشر نخواهد شد.