راهنمای سبک کدنویسی JavaScript

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

1. فرمت‌بندی کد

• تورفتگی (Indentation): برای هر سطح تورفتگی از ۲ فاصله استفاده کنید (یا ۴ فاصله در صورت ترجیح).
• طول خطوط: خطوط را به حداکثر ۸۰-۱۰۰ کاراکتر محدود کنید.
• نقطه ویرگول (Semicolon): همیشه از نقطه‌ویرگول برای خاتمه دستورات استفاده کنید.
• گیومه‌ها (Quotes): از تک‌گیومه (') برای رشته‌ها استفاده کنید، مگر اینکه رشته شامل تک‌گیومه باشد.
• ویرگول‌های انتهایی: در آرایه‌ها و اشیای چندخطی از ویرگول انتهایی استفاده کنید.

const user = {

   name: ‘John’,

age: 30,

};

2. اعلام متغیرها

• از const برای متغیرهایی که تغییر نمی‌کنند استفاده کنید.
• از let برای متغیرهایی که ممکن است تغییر کنند استفاده کنید.
• از var برای تعریف متغیر استفاده نکنید.
• برای متغیرها از نام‌های معنادار و توصیفی استفاده کنید.

const maxItems = 10; // مناسب

let userName = ‘Alice’; // مناسب

3. توابع

• برای توابع بی‌نام از توابع فلش (Arrow Functions) استفاده کنید، مگر اینکه به this نیاز داشته باشید.
• نام توابع را متناسب با هدفشان انتخاب کنید.
• از تو در تو کردن غیرضروری توابع اجتناب کنید.

const add = (a, b) => a + b;

function getUserData(id) {

// منطق تابع

}

4. اشیا و آرایه‌ها

• از نام‌های مختصر در تعریف اشیا استفاده کنید.
• از تجزیه (Destructuring) اشیا و آرایه‌ها برای خوانایی بهتر استفاده کنید.

const name = ‘Alice’;

const user = { name }; // استفاده از حالت مختصر

const [first, second] = [10, 20]; // تجزیه آرایه

const { age } = user; // تجزیه شیء

5. رشته‌ها

• برای رشته‌های چندخطی یا جای‌گذاری متغیرها در رشته‌ها از قالب‌های رشته‌ای (Template Literals) استفاده کنید.

const name = ‘John’;

console.log(`Hello, ${name}!`);

6. توضیحات (Comments)

• توضیحات را برای توضیح چرا، و نه چیستی کد بنویسید.
• از // برای توضیحات یک‌خطی و از /* */ برای توضیحات چندخطی استفاده کنید.

// این تابع جمع دو عدد را محاسبه می‌کند

const sum = (a, b) => a + b;

7. ساختارهای کنترلی

• حتی برای بلوک‌های تک‌خطی از آکولادها {} استفاده کنید.
• از برابری سخت (=== و !==) برای جلوگیری از مشکلات تغییر نوع داده استفاده کنید.

if (user) {

console.log(‘User exists’);

}

8. مدیریت خطاها

• برای بخش‌های بحرانی یا در استفاده از async/await از بلوک‌های try...catch استفاده کنید.
• از خطاهای عمومی خودداری کنید و خطاهای مشخص ایجاد کنید.

try {

const data = await fetchData();

} catch (error) {

console.error(‘Data fetch failed’, error);

}

10. ابزارهای بررسی کد (Linting)

• از ابزار بررسی کد مانند ESLint برای اطمینان از یکنواختی سبک و شناسایی خطاها استفاده کنید.
• تنظیمات پیکربندی محبوب مانند eslint:recommended یا Airbnb Style Guide را به کار ببرید.

راهنماهای سبک محبوب

• Airbnb JavaScript Style Guide: بسیار محبوب و به طور گسترده استفاده می‌شود.
• Google JavaScript Style Guide: ساده و ساختارمند.
• StandardJS: بدون نقطه‌ویرگول و حداقل تنظیمات.