کدنویسی تمیز یا Clean code و بهینگی کد Code optimization به قدری مهم است که در صورتی که یک برنامه نویس از آن پیروی نکند هم خودش را سردرگم میکند و هم اینکه کسی حاضر نیست در پروژه وی همکاری داشته باشد. در پروژه های تحت وب و سایت های اینترنتی کدنویسی تمیز و بهینه یک اصل مهم است و با رعایت آن سایت هایی سریع، قابل توسعه بالا و قابل درک برای برنامه نویسان دیگر ایجاد می کنید.
در این مطلب درباره کدنویسی تمیز و بهینه سازی کدها نکاتی را یاداور می شویم تا علاقه مندان به برنامه نویسی با این مفاهیم آشنایی کامل داشته باشند و با رعایت اصول نوشتن کدنویسی تمیز و بهینه، محصولات نرم افزاری تحت وب کاربردی، سریع و با کارایی بالا تولید نمایند.
کدنویسی تمیز یا Clean code چیست؟
کدنویسی تمیز به انگلیسی Clean Code به مجموعه ای از اصول و رویکردهایی گفته می شود تا کدهایی نوشته شوند که قابل فهم، درک و اصلاح توسط خودتان و دیگر برنامه نویسان باشد. این نوع کدنویسی در مقابل کدنویسی کثیف یا Dirty Code قرار دارد که باعث می شود از نوشتن کدهای بی نظم، غیرقابل درک و رویه های تکراری اجتناب کنید.
بسیاری از برنامه نویسان بدون رعایت اصول پایه کدنویسی، عدم استفاده از یک معماری درست، عدم بهینه کردن کدها و …. اقدام به نوشتن خطوط متعدد کد میکنند و پس از مدتی حتی خوشان هم قادر به تحلیل و اصلاح کدهای خود نیستند. از طرفی اگر از یک برنامه نویس دیگر نیز بخواهید در پروژه شما همکاری نماید با دیدن کدهای شما به سرعت از اینکار انصراف می دهد. در سوی دیگر عدم بهینه بودن کدها در بلندمدت مشکلات فراوانی را برای پروژه نرم افزاری شما به وجود خواهد آورد. از پرفورمنس گرفته تا عدم امکان توسعه و …
در متدولوژی هایی مانند چابک (Agile) کدنویسی تمیز ضرروری و یکی از اصول مهم در توسعه نرم افزار است. زیرا تیم توسعه، در بسیاری از موارد با یکدیگر همکاری دارند یا ناچارند کدهای یکدیگر را تکمیل یا اصلاح نمایند.
بهینگی کدنوسی و بهینه سازی کد چیست؟
بهینگی کدنوسی با کدنوسی تمیز در ارتباط است و بهینگی کد عموما به خاطر کارایی و نگهداری از کد حائز اهمیت می‌باشد. در طول فرآیند توسعه یک نرم افزار تصمیماتی اتخاذ می شود و مدل سازی اولیه برنامه صورت میگیرد که ممکن است این تصمیمات و کدهای مدل سازی شده از لحاظ کارایی، بهینگی و نگهداری معادل سورس کد نهایی نباشند، اما برخی از برنامه نویسان به دلیل عدم وقت کافی، عدم اهمیت دادن به پروژه یا مسائل دیگر از کدهای مدل شده و بیسیک برای پروژه نهایی استفاده میکنند که علاوه بر ایجاد عدم کارایی، پرفرمنس پایین و نگهداری سخت، در نهایت باعث کدنویسی کثیف با Dirty Code میگردد.
باید دقت داشت که کدنویسی تمیز و بهنیه نوشتن کد از اهمیت بسیار بالایی برخوردار است چرا که در اصل یک برنامه در طول زمان نیاز به نگهداری، رفع باگ و افزایش کارایی دارد و در اصل برنامه نویس به طور مداول در حال بهینه سازی کدهای خود است. حال اگر دو اصل اول یعنی کدنویسی تمیز و بهنیه رعایت نشده باشد، اصل سوم یعنی بهنیه سازی کد امکان پذیر نخواهد بود.
کدنویسی تمیز و بهینه در توسعه وب سایت با اهمیت تر است
کدنویسی تمیز در برنامه نویسی و توسعه هر نرم افزاری حائز اهمیت است اما در برنامه های تحت وب و وب سایت ها اهمیت کدنویسی تمیز دوچندان خواهد شد. عموما برنامه های تحت وب به تغییرات بیشتری نیاز دارند و ممکن است یک برنامه تحت وب در چرخه حیات خود از چند تیم برنامه نویسی برای ثبت تغییرات و بروزرسانی استفاده نماید. از این رو کدهای تمیز، خوانا و قابل فهم برای تیم توسعه و برنامه نویس از اهمیت بسیار بالایی برخوردار است تا در گذر زمان امکان ثبت تغییرات و توسعه برنامه را فراهم نماید.
از طرفی دیگر یک برنامه تحت وب نیاز به افزایش کارایی و سرعت اجرای بالا دارد. بهینه بودن کدها و بهینه سازی مداوم کد عضو جدایی ناپذیر برنامه نویسی تحت وب است. تنها با داشتن کدهای تمیز و بهینه که امکان بهینه سازی کدها را در گذر زمان فراهم می کند می توان به یک برنامه سریع با مصرف کم دست یافت. دقت داشته باشید در برنامه های تحت وب یکی از اهداف برنامه نویس تلاش برای کاهش مصارف (CPU یا حافظه) از جانب کد و سرعت اجرای بالا است.
چگونه کدنویسی تمیز و بهینه انجام دهیم؟
انجام کدنویسی تمیز و بهینه برای بسیاری از برنامه نویسان به یک کابوس تبدیل شده چرا که هر چقدر تلاش می کنند در نهایت به کدهای کثیف منجر می‌شود. یکی از ریشه ای ترین عوامل برای این مشکل را می توان عدم درک صحیح از اصول مهندسی نرم افزار دانست. بسیاری از برنامه نویسان بدون توجه به اصول مهندسی نرم افزار و عدم مطالعه و کسب دانش در این زمینه شروع به کدنویسی میکنند که همین امر باعث می شود که تلاش های کدنویسی آنها تمیز و بهینه نباشد.
برنامه نویس ها لازم است قبل از هر چیز درباره اصول مهندسی نرم افزار و برخی از اصول های پایه برنامه نویسی مطالعه و تحقیق کنند تا به درک کاملی از این مفاهیم برسند. همچنین با مطالعه الگوریتم های طراحی و برنامه نویسی تفکر طراحی و الگوریتمیک پیدا نمایند. بعد از آن مسیر برای دستیابی به کدهای تمیز و بهینه بسیار ساده خواهد بود.
در ادامه ما موارد مهمی که برنامه نویسان برای دستیابی به کدنویسی تمیز و بهینه نیاز دارند را لیست کرده ایم. امیدواریم با مطالعه در این زمینه ها مهارت های خود را در زمینه کدنویسی تمیز بهبود ببخشید. تاکید می کنیم «کدنویسی تمیز»!
مطالعه در زمینه الگوریتم‌های طراحی
الگوریتم‌ها (Algorithms) به شما کمک می کنند که یک مسئله را چگونه باید حل کنید. بنابراین مطالعات و بالا بردن توانایی های خود در الگوریتم نویسی بسیار حائز اهمیت است. عموما برنامه نویسانی که دراستفاده از الگوریتم‌ها و نوشتن الگوریتم‌های جدید مهارت داشته باشند می توانند راه حل های بهینه و مناسبی را برای مسائل خود کشف کنند که در نهایت در پیاده سازی برنامه و نوشتن کدهای بهینه نیز موفق تر خواهند بود.
مطالعه در زمینه الگوهای طراحی
الگوهای طراحی (Design Patterns) و استفاده درست از انها یکی از اصول مهندسی نرم افزار است و به شما راه حل های ثابتی برای مشکلات رایج برنامه نویسی می‌دهد. با مطالعه در این زمینه و استفاده از یک معماری قابل اطمینان بسیاری از مشکلات رایج برنامه نویسی شما مرتفع می گردد. در اصل تسلط داشتن روی دیزاین پترن‌ها بسیاری از مشکلات احتمالی در برنامه نویسی را کاهش می‌دهد و باعث ارتقا سطح فنی کدها می‌شود.
مطالعه در زمینه ساختمان داده ها
یکی از مباحث مهم در برنامه نویسی ساختمان داده ها و استفاده صحیح از آنهاست. بدون درک کاملی از ساختمان داده ها برنامه نویسی با منطق صحیح و سرعت مناسب یک شوخی به نظر میرسد. با مطالعه در این زمینه و استفاده صحیح از داده ها و ترکیب با الگوریتم های طراحی به یک منطق صحیح و برنامه پرسرعت دست خواهید یافت.
مطالعه و تسلط کافی بر زبان برنامه نویسی مورد نظر
تسلط بر زبان برنامه نویسی و استفاده صحیح از توابع و امکانات زبان برنامه نویسی در نوشتن کدهای بهینه و تمیز کمک شایانی به شما می کند. عموما برنامه نویس هایی که تسلط کافی و درک کاملی از توابع، استفاده صحیح از ابزارها و امکانات زبان مورد نظر جهت برنامه نویسی ندارند قادر نیستند کدهای تمیز و کاملی را بنویسند.
مشاهده و بررسی کدهای برنامه نویسان ارشد
مشاهده و بررسی کدهای سایر برنامه نویسان که سطح کدنویسی بالاتری از شما دارند می تواند شما را در بهبود کدنویسی و یادگیری تکنیک های برنامه نویسی یاری نماید. متاسفانه اکثر برنامه نویسان علاقه ای به بررسی و دیدن کدهای سایر برنامه نویسان ندارند که این یک نقطه ضعف محسوب می شود.
رعایت اصول کدنویسی تمیز
چند اصل بنیادی در کدنویسی تمیز از اهمیت بالایی برخوردار هستند که همه برنامه نویسان برای دستیابی به کدهای تمیز و قابل فهم و درک نیاز مبرمی به رعایت آن دارند. در ادامه به این اصول که ساده هستند اشاره میکنیم.
تا می توانید کدهای ساده بنویسد
سادگی کدها یکی از اصول پایه در کدنویسی تمیز است. این اصل به KISS معروف است و مخفف عبارت keep it simple stupid است. KISS یک اصل طراحی است که توسط نیروی دریایی ایالات متحده در سال ۱۹۶۰ مورد توجه قرار گرفت که البته به این موضوع کار نداریم. اما به شکل ساده در برنامه نویسی به این معنی است که از پیچیدگی بیش از حد کدها بپرهیزیم و در ساده‌ترین شکل ممکن برنامه نویسی کنیم. همیشه سعی کنید توابع را در ساده‌ترین شکل ممکن بنویسید و تاحد ممکن از اضافه کردن پیچیدگی‌های بی مورد دوری کنید.
کدهای قابل درک بنویسید
خوانایی و قابل فهم بودن کدها باعث صرفه جویی در زمان برای رفع مشکلات و دیباگ کردن کدها خواهد شد. هرچه میزان خوانایی و فهم کدها راحت‌تر باشد، زمان کمتری برای اصلاح آنها لازم است.
از اسامی واقعی و نام گذاری درست استفاده کنید
برای کلاس‌ها، توابع، متغیرها و هر چیزی، نام گذاری مناسب انجام دهید. به طور مثال اگر عملکرد یک تابع جمع دو عدد است نام تابع باید نمایانگر این عمل باشد. این کار به ترتیب روند کار و راحتی در جستجوی بخش‌های مختلف کمک زیادی خواهد کرد.
پارامترهای بیش از حد ممنوع
بهتر است توابع و حتی کلاس ها پارامتر و آرگومان‌های زیادی نداشته باشند. همچنین بدنه هر تابع را تا جایی که ممکن است به قسممت‌های مختلف شکسته و در توابع مختلف قرار دهید.
کامنت گذاری را اصولی انجام دهید
برخی برنامه نویسان کامنت گذاری زیادی بین کدهای خود دارند و برخی دیگر هم کامنت های سطحی و نامفهومی را بین کدهای خود قرار می دهند. هر دو مورد یک نقطه ضعف در نوشتن کدهای تمیز محسوب می شود. به عبارتی اگر در کد خود کامنت‌های زیادی می‌گذارید احتمالا کدهای شما به حد کافی قابل فهم و واضح نیست. از طرفی اگر کامنت نمی گذارید یا کامنت های شما عملکرد، پارامترها، ترتیب اجرا و چنین مسائلی را مشخص نمی کند، قطعا در اینده برای خود و دیگران سردرگمی ایجاد می‌کنید.
تا می توانید وابستگی را کاهش دهید.
وابستگی‌ها (Dependencies) یکی از مشکلاتی است که نگهداری و تغییر در پروژه را سخت می کند. بهتر است وابستگی ها تا حد امکان کم باشند تا نگهداری و تغییر کدها در آینده راحت باشد. بد نیست دباره اصول solid در برنامه نویسی شی گرا مطالعه کنید.