Style Guide

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

🔹 نکات کلیدی Style Guide

1. نام‌گذاری متغیرها و توابع

  • از camelCase برای متغیرها و توابع استفاده کنید:

let userName = "Ali"; function calculateSum(a, b) { return a + b; }
  • از PascalCase برای کلاس‌ها استفاده کنید:

class UserAccount { }

2. فاصله و تورفتگی (Indentation)

  • از 2 یا 4 فاصله برای تورفتگی استفاده کنید، همیشه یکسان

function greet(name) { console.log("Hello " + name); }

3. کوتاه و خوانا نوشتن کد

  • هر خط کد را کوتاه نگه دارید (حدود 80–120 کاراکتر)

  • توابع کوچک و یک وظیفه‌ای بنویسید

4. استفاده از ; (Semicolon)

  • توصیه می‌شود از Semicolon در پایان هر دستور استفاده کنید:

let x = 5; console.log(x);

5. فاصله در اطراف عملگرها

let sum = a + b; if (x === 10) { console.log("x is 10"); }

6. کامنت‌گذاری

  • از کامنت‌های تک‌خطی (//) برای توضیح کوتاه

  • از کامنت‌های چندخطی (/* ... */) برای توضیح طولانی یا مستندات

// محاسبه مجموع دو عدد function sum(a, b) { return a + b; } /* این تابع مجموع دو عدد را برمی‌گرداند و برای مثال‌های آموزشی استفاده می‌شود */

7. استفاده از const و let به جای var

  • const → برای مقادیری که تغییر نمی‌کنند

  • let → برای مقادیر قابل تغییر

  • از var پرهیز کنید

const pi = 3.14; let radius = 5;

8. ترتیب بخش‌ها

  • تعریف متغیرهاتوابع کمکیتوابع اصلیکد اجرایی

🔹 منابع معروف Style Guide

✅ خلاصه

  • Style Guide → قوانین نوشتن کد خوانا و قابل نگهداری

  • مهم‌ترین نکات: نام‌گذاری، تورفتگی، کوتاهی خطوط، استفاده از const/let، فاصله‌ها، کامنت‌ها

  • پیروی از یک Style Guide → کاهش خطا و افزایش کیفیت کد