مقدمه
به فصل «توصیه‌های کاربردی» خوش آمدید. در این فصل، از مباحث فنی APIها فاصله گرفته و به بررسی
بهترین شیوه‌ها (best practices) برای نوشتن کدهای حرفه‌ای می‌پردازیم. اولین و شاید مهم‌ترین جنبه،
«قابلیت نگهداری» (Maintainability) کد است. یک ضرب‌المثل معروف در برنامه‌نویسی می‌گوید: "کد همیشه
برای کامپیوترها نوشته نمی‌شود، بلکه برای انسان‌ها نیز هست." کدی که فقط "کار می‌کند" اما خوانا و
قابل فهم نیست، در آینده به یک کابوس برای دیباگ کردن، توسعه دادن، و همکاری تیمی تبدیل خواهد شد.
سرمایه‌گذاری برای نوشتن کد تمیز، در بلندمدت باعث صرفه‌جویی بسیار زیادی در زمان و هزینه می‌شود.
سبک کدنویسی یکپارچه و خوانا
داشتن یک سبک کدنویسی (Coding Style) یکسان در سراسر پروژه، خوانایی آن را به شدت افزایش می‌دهد.
این سبک شامل مواردی مانند نحوه تورفتگی (indentation)، فاصله‌گذاری، نام‌گذاری متغیرها، و استفاده
از نقطه‌ویرگول می‌شود.
استفاده از Linter و Formatter
بحث بر سر جزئیات سبک کدنویسی (مانند اینکه از ۲ فاصله برای تورفتگی استفاده کنیم یا ۴ فاصله)
بی‌فایده است. بهترین راه، خودکارسازی این فرآیند با استفاده از ابزارهاست:
- Linter (مانند ESLint): یک ابزار تحلیل کد است که به صورت خودکار کد شما را برای
یافتن مشکلات بالقوه، باگ‌های رایج، و عدم رعایت استانداردهای تعریف‌شده بررسی می‌کند.
- Formatter (مانند Prettier): یک ابزار قالب‌بندی کد است که به صورت خودکار کد شما
را بر اساس مجموعه‌ای از قوانین، بازنویسی و مرتب می‌کند. این کار تمام بحث‌های مربوط به استایل
را از بین می‌برد.
استفاده ترکیبی از این دو ابزار در پروژه‌های مدرن یک امر ضروری است و تضمین می‌کند که تمام کدهای
نوشته شده توسط اعضای تیم، از یک استاندارد واحد پیروی می‌کنند.
هنر نوشتن کامنت‌های مفید
یک قانون طلایی در برنامه‌نویسی می‌گوید: «کد خوب، خود-مستند (self-documenting) است». این یعنی کد
باید آنقدر خوانا و واضح نوشته شود که نیاز به توضیح اضافه نداشته باشد. کامنت‌ها نباید کاری را که
کد انجام می‌دهد، توضیح دهند؛ بلکه باید بگویند چرا آن کار را به آن روش خاص انجام
می‌دهد.
JAVASCRIPT
counter++;
const adjustedIndex = apiIndex - 1;
کامنت‌های بد کد را شلوغ کرده و به مرور زمان با تغییر کد، قدیمی و اشتباه می‌شوند. اما کامنت‌های
خوب، زمینه و منطق پشت یک تصمیم پیچیده را روشن می‌کنند و برای هم‌تیمی‌ها یا خود شما در آینده
بسیار ارزشمند خواهند بود.
اصول ساختار کد خوب
چندین اصل مهندسی نرم‌افزار وجود دارد که به ما در نوشتن کدهای ماژولار، قابل فهم و قابل تست کمک
می‌کنند.
اصل DRY (Don't Repeat Yourself)
از تکرار کردن قطعه کدهای یکسان در بخش‌های مختلف پروژه خودداری کنید. اگر بخشی از منطق در چند جا
استفاده می‌شود، آن را در یک تابع قابل استفاده مجدد (reusable function) قرار دهید. این کار نه
تنها حجم کد را کم می‌کند، بلکه اگر در آینده نیاز به تغییر آن منطق داشته باشید، فقط کافیست یک
تابع را ویرایش کنید.
اصل تک-مسئولیتی (Single Responsibility Principle)
هر تابع یا ماژول باید تنها یک مسئولیت مشخص داشته باشد و آن را به خوبی انجام دهد. از نوشتن توابع
غول‌پیکری که چندین کار مختلف را با هم انجام می‌دهند، پرهیز کنید. توابع کوچک و متمرکز، راحت‌تر
فهمیده، تست و دیباگ می‌شوند.
نام‌گذاری توصیفی
یکی از مهم‌ترین و در عین حال ساده‌ترین کارها برای افزایش خوانایی کد، انتخاب نام‌های خوب است. نام
متغیرها، توابع و کلاس‌ها باید به وضوح هدف و کارکرد آنها را توصیف کند. نامی مانند
fetchAndProcessUserData بسیار بهتر از یک نام مبهم مانند getData یا
handleStuff است.
استفاده از سیستم کنترل نسخه (Git)
استفاده از یک سیستم کنترل نسخه، به ویژه Git، برای هر پروژه نرم‌افزاری مدرن، یک امر
غیرقابل مذاکره است. Git به شما اجازه می‌دهد تا تاریخچه تمام تغییرات کد را ثبت کنید، با
دیگران به صورت موازی روی پروژه کار کنید، شاخه‌های (branches) مجزا برای توسعه ویژگی‌های جدید
بسازید، و در صورت بروز مشکل، به راحتی به نسخه‌های قبلی و سالم کد بازگردید.
در این درس با اصول کلیدی برای نوشتن کدهای تمیز و قابل نگهداری آشنا شدیم. رعایت یکپارچگی در سبک
کدنویسی، نوشتن کامنت‌های هوشمندانه، پیروی از اصول ساختاری مانند DRY، و استفاده از کنترل
نسخه، همگی به سلامت بلندمدت، مقیاس‌پذیری و موفقیت پروژه شما کمک شایانی می‌کنند. در درس بعدی، به
یکی دیگر از جنبه‌های حیاتی توسعه وب، یعنی «توصیه‌های مربوط به Performance»، خواهیم پرداخت و یاد
می‌گیریم که چگونه سرعت و کارایی اپلیکیشن‌های خود را بهینه کنیم.