Style Guide یا راهنمای شیوه برای جاوا اسکریپت
ﺯﻣﺎﻥ ﻣﻄﺎﻟﻌﻪ: 7 دقیقه

Style Guide یا راهنمای شیوه برای جاوا اسکریپت

هر برنامه‌نویسی می‌تواند کد را متفاوت از شخص دیگری بنویسد. این چیز خوبی است به شرطی که هرکسی روی کد خود به تنهایی کار کند. اما وقتی بیش از چند توسعه‌دهنده در یک پایگاه کد یکسان با هم کار کنند، چه اتفاقی می‌افتد؟ در این صورت همه چیز می‌تواند بسیار آشفته شود.

اینجاست که یک راهنمای سبک می‌تواند بسیار مفید باشد. راهنمای سبک مجموعه‌ای از استانداردها است که نحوه نوشتن کد، قالب‌ بندی و سازماندهی آن را مشخص می‌کند.

استفاده از یک راهنمای سبک استاندارد تضمین می‌کند که کد به راحتی بین توسعه‌دهندگان به اشتراک گذاشته می‌شود. در نتیجه هر توسعه‌دهنده جدیدی می‌تواند در مدت زمان کوتاهی با یک کد مشخص سازگار شده و کدی بنویسد که سایر توسعه‌دهندگان بتوانند به آسانی آن را درک کنند.

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

 1. Airbnb Style Guide

از زمان انتشار آن در سال 2012 تاکنون، محبوبیت زیادی پیدا کرده است و در حال حاضر رایج‌ترین و مرتبط‌ترین راهنمای سبک برای بسیاری از توسعه‌دهندگان است. Airbnb آن را منطقی‌ترین رویکرد برای جاوااسکریپت معرفی می‌کند.

مزیت آن این است که تقریبا همه جنبه‌های برنامه‌نویسی جاوااسکریپت را پوشش می‌دهد، از کار با شی‌ها گرفته تا تست عملکرد.

اگر چه محدودیت‌هایی دارد، اما این راهنمای سبک کاملا بصری است و بسیاری از قوانین آن منطقی به نظر می‌رسند. علاوه بر این قوانین آن به شما کمک می‌کند تا یک سبک برنامه‌نویسی ثابت داشته باشید.

توسعه‌دهندگان عمدتا به 4 دلیل به Airbnb JavaScript Style علاقه دارند:

  • ثبات
  • خوانایی
  • قابل پیش‌بینی بودن
  • بهره‌وری

در حال حاضر، راهنمای سبک Airbnb معمولا در بسیاری از شرکت‌ها و استارتاپ‌ها با استفاده از فریمورک‌های مدرنی مانند React استفاده می‌شود.

می‌توانید راهنمای کامل آن را از اینجا ببینید.

2. JavaScript Standard Style

این راهنمای سبک همراه با یک linter و یک اصلاح کننده خودکار کد است که توسط Feross Abukhadijeh تحت مجوز MIT تأسیس و منتشر شده است.

بهترین چیز در مورد JavaScript Standard Style سادگی آن است. به این صورت که شما نیازی به نگهداری چندین فایل پیکربندی صد خطی برای هر ماژول یا پروژه‌ای که روی آن کار می‌کنید، ندارید.

سه دلیل اصلی وجود دارد که شما باید از این راهنمای سبک استفاده کنید:

  • بدون پیکربندی: ساده‌ترین راه برای حفظ سبک سازگار در پروژه شما.
  • قالب بندی خودکار کد: فقط کافی است آن را اجرا کنید و راهنمای سبک از کد نامرتب یا ناسازگار شما مراقبت می‌کند.
  • مشکلات مربوط به کد و خطاهای برنامه‌نویسی را زودتر بیابید: با بهره‌گیری از آن در زمان بررسی کد و رفع باگ‌ها صرفه جویی کنید.

استفاده از JavaScript Standard Style بسیار ساده است. شما می‌توانید کد جاوااسکریپت را به روش خود تایپ کرده و از طریق پکیج استاندارد node آن را اجرا نمایید. بدین ترتیب کد شما به صورت خودکار قالب‌بندی می‌شود.

این راهنمای سبک توسط بسیاری از شرکت‌های فناوری از جملهnode JS ،NPM ،GitHub ، Heroku و GoDaddy مورد استفاده قرار می‌گیرد.

در صورت تمایل می‌توانید آن را فورک کرده، تغییرات مد نظر را ایجاد کنید، کامیت کنید و در پروژه بعدی خود استفاده نمایید یا از آن به عنوان نمونه‌ای برای ایجاد یک پروژه در شرکت خود استفاده کنید. همچنین می‌توانید راهنمای کامل آن را از اینجا ببینید.

3. Idiomatic JavaScript Style Guide

همه کدها در هر پایگاه کد بدون توجه به تعداد افرادی که روی آن مشارکت داشته‌اند، باید طوری به نظر برسد که انگار یک نفر آن را نوشته است.

Idiomatic یکی دیگر از محبوب‌ترین راهنماهای سبک جاوااسکریپت است. این ابزار سال‌هاست که وجود دارد و وقتی آن را بررسی کنید، متوجه می‌شوید که شامل قوانین زیادی برای اجرای پایدار، خوانایی بالا و قابلیت نگهداری کد شما است.

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

تا آنجا که من می‌دانم، هیچ ابزار linting برای قرار دادن آن در جریان توسعه شما وجود ندارد. اما قطعا ارزش بررسی را خواهد داشت و می‌بینید که قوانین آن در مورد کدی که می‌نویسید چگونه اعمال می‌شود.

آیا برای کمک به بهبود Idiomatic می‌خواهید همکاری کنید؟ پس راهنمای سبک آن را بخوانید و نحوه قالب‌بندی جاوااسکریپت را بیاموزید. همچنین می‌توانید آن را از اینجا مشاهده کنید.

4. Google Style Guide

گوگل در حوزه پروژه‌های متن باز کاملا شناخته شده است و هر پروژه بزرگ آن دارای راهنمای سبک خاص خود است تا درک پایگاه داده را آسان کند. راهنمای سبک جاوااسکریپت گوگل در سال 2012 منتشر شد و بسیاری از طرح‌های متن باز جاوااسکریپت گوگل از این راهنمای سبک پیروی می‌کنند.

این احتمالا جزو رایج‌ترین راهنماهای سبک موجود نیست، اما کاملا واضح است که در خود گوگل بسیار مورد توجه قرار گرفته است.

با این حال قوانین زیبایی برای پیاده سازی وجود دارد و یک پکیج ESLint همراه آن است که می‌توانید از آن برای قرار دادن راهنمای سبک در پروژه خود استفاده کنید.

راهنمای سبک گوگل را می‌توان به دو قسمت تقسیم کرد که بر قوانین سبک جاوااسکریپت (مسائل زیبایی شناختی قالب بندی) تمرکز دارد و تنها بر قراردادها و استانداردهای کدنویسی متمرکز است. از اینجا می‌توانید آن را مشاهده کنید.

5. jQuery JavaScript Style Guide

توسعه‌دهندگان جی‌کوئری که کد جاوااسکریپت می‌نویسند، سال‌هاست راهنمای سبک jquery JavaScript Style را دنبال می‌کنند. بنابراین می‌توانند این ماژول را ادغام کرده و بررسی کنند که آیا کد آنها مطابق با راهنمای سبک استاندارد جی‌کوئری نوشته شده است یا خیر.

صدها ماژول و پروژه جی‌کوئری وجود دارد که از دستورالعمل‌های اصلی سبک جاوااسکریپت پیروی می‌کند. می‌توانید راهنمای کامل آن را از اینجا مشاهده کنید.

جمع‌بندی

تصور کنید که در یک تیم بزرگ با توسعه‌دهندگان دیگر کار می‌کنید. در این صورت هرکس شیوه خود را برای نحوه نوشتن بخش خاصی از کد خواهد داشت.

ممکن است در هیچ یک از روش‌های آنها مشکلی وجود نداشته باشد، اما اگر توسعه‌دهندگان مختلف به گونه‌ای متفاوت کد بنویسند، پایگاه کد شما کمی ناخوانا به نظر می‌رسد. همچنین توسعه‌دهندگان جدیدی که به تیم اضافه می‌شوند لزوما نمی‌دانند از چه روشی استفاده کنند.

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

امیدوارم این توضیحات برایتان مفید واقع شود. در بخش نظرات بنویسید که راهنمای سبک مورد علاقه شما چیست و اگر نمونه دیگری را سراغ دارید حتما آن را به اشتراک بگذارید.

در صورت تمایل برای یادگیری بیشتر جاوااسکریپت می‌توانید از این دوره مفید و ارزشمند در راکت استفاده نمایید.

چه امتیازی برای این مقاله میدهید؟

خیلی بد
بد
متوسط
خوب
عالی
در انتظار ثبت رای

/@arastoo
ارسطو عباسی
کارشناس تولید و بهینه‌سازی محتوا

کپی رایتر، یوایکس رایتر، متخصص سئو محتوا و… عناوینی هستن که می‌تونم حرفه‌ام رو باهاشون خلاصه کنم اما جدای از این موارد، کتاب نوشتم، پادکست ضبط کردم، مارکتینگ محتوا انجام دادم و خلاصه تجربیات تا بخوایید در زمینه کلمات کسب کردم.

دیدگاه و پرسش

برای ارسال دیدگاه لازم است وارد شده یا ثبت‌نام کنید ورود یا ثبت‌نام

در حال دریافت نظرات از سرور، لطفا منتظر بمانید

در حال دریافت نظرات از سرور، لطفا منتظر بمانید

ارسطو عباسی

کارشناس تولید و بهینه‌سازی محتوا