۱۰ نکته برای نوشتن کد تمیز و خوانا

نوشتن کد تمیز و خوانا یکی از مهم‌ترین وظایف بر عهده یک برنامه‌نویس است. اهمیت خوانا بودن کد زمانی مشخص می‌شود که تصمیم می‌گیرید کد را اتقاء دهید یا شخص دیگری قرار است روی کد شما کار کند. آموزش‌های اصولی برنامه‌نویسی همه در ابتدا روی نوشتن کد تمیز تاکید می‌کنند اما برخی از برنامه‌نویس‌ها اهمیت آن را درک نکرده یا آن را جدی نمی‌گیرند. در این پست ۱۰ نکته کاربردی برای نوشتن کد تمیز و خوانا را توضح داده‌ایم تا هر کس که کد شما را دید، متوجه شود این کد را یک برنامه‌نویس حرفه‌ای نوشته است.از نام‌های مشخص و توضیحی استفاده کنیدتا به حال برای متغیرها از i و j و x و n استفاده می‌کرده‌اید؟ در کدهای کوچک با کاربرد محدود این نام‌گذاری‌ها رایج است اما در برنامه‌های بزرگ با چندین هزار خط، ممکن است سردرگمی‌ ایجاد کند. برای فانکشن‌ها هم از افعال استفاده کنید. برای مثال اگر یک فانکشن دارید که نام و نام خانوادگی دکتر را بر می‌گرداند، می‌توانید از getDoctorName استفاده کنید. داخل این فانکشن هم نام و نام خانوادگی دکتر را به صورت const lastNameDoctor و const FirstNameDoctor بنویسید.از فضای خالی برای خوانایی کد استفاده کنیدبین متغیرهای تعریف‌شده، فانکشن‌ها و returnها جای خالی قرار دهید. به این ترتیب چشم راحت‌تر کد را خوانده و بررسی می‌کند.بیشتر از ۳ پارامتر در یک فانکشن استفاده نکنیدبه یاد داشته باشید یک فانکشن باید خوانا باشد. بیش از ۳ پارامتر در فانکشن می‌تواند باعث به هم‌ریختگی کد شود. اگر به بیش از ۳ پارامتر نیاز دارید، می‌توانید یک آبجکت به فانکشن ارسال کنید و از keyهای آبجکت برای ارسال پارامترها بهره ببرید.هر فانکشن باید یک وظیفه را انجام دهدایجاد وظایف مختلف داخل یک فاکنشن وسوسه‌کننده است، اما به یاد داشته باشید یک فانکشن باید یک وظیفه را انجام دهد.فانکشن‌ها باید کوتاه باشنداگر تعداد خط‌های فانکشن شما زیاد است، بهتر از کلاس استفاده کنید. یک فانکشن باید کوتاه باشد و تنها یک کار انجام دهد.تعداد کاراکترهای داخل یک خط را کم کنیداز خط‌های طولانی در کد استفاده نکنید. اگر هنگام نوشتن یک خط نیاز به اسکرول افقی داشتید، آن خط بیش از حد طولانی است.تعداد کامنت‌ها را کم کنیدکامنت‌ها برای توضیح کار فانکش‌ها و کلاس‌ها و… استفاده می‌شوند اما اگر فانکشن شما از اسم‌های توصیفی استفاده کند و برای دیگران قابل درک باشد، نیازی به کامنت نیست. برخی از برنامه‌نویس‌ها تصویر می‌کنند کامنت‌های زیاد به خوانایی کد کمک می‌کند، حال آن‌که همین کامنت‌ها می‌توانند باعث سردرگمی شوند. از طرفی برنامه‌نویس‌های بعدی باید ضمن تغییر کد به طور مداوم کامنت‌ها را نیز تغییر دهند.هنگام ساخت یک کامیت از پیام‌های توصیفس استفاده کنیدنوشتن پیام‌های توصیفی هنگام ساخت یک کامیت به درک کد کمک می‌کند. توجه کنید که پیام شما باید یک جمله باشد و اطلاعات کامل را به خواننده کد انتقال دهد.از یونیت تست استفاده کنیدشاید یونیت تست کردن کاری بیهوده به نظر برسد، اما اینطور نیست! تصور کنید شخص دیگر روی کدی که شما ماه‌ها پیش نوشته‌اید کار می‌کند و فانکشنی نوشته که یک مشکل را حل کرده اما در کار فانکشن دیگر تداخل ایجاد می‌کند. چطور از این تداخل مطلع می‌شوید؟ اگر یونیت تست‌ها را داشته باشید، این کار به راحتی قابل انجام است. طبیعی است که گاهی نیاز دارید در مدت کوتاهی موارد زیادی را تحویل دهید، اما زمانی که برای یونیت تست می‌گذارید می‌تواند در آینده زمان بیشتری برای شما صرفه‌جویی کند.الگوهای طراحی را یاد بگیریدالگوهای طراحی (یا Design Patterns) موضوعی گسترده است. اگر با الگوهای طراحی آشنا باشید، با راهکارهایی آشنا می‌شوید که پاسخ برخی از مشکلات بسیار معمول در دنیای برنامه‌نویسی است. بنابراین مطالعه الگوهای طراحی را جزء اولویت‌های خود قرار دهید.