021-28423015

راهنمای جاوا اسکریپت و قراردادهای کد گذاری

همیشه از همان دستورالعمل های برنامه نویسی برای همه پروژه های جاوااسکریپت خود استفاده کنید.

توافقنامه کدگذاری جاوا اسکریپت

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

  • نامگذاری و اعلام قوانین برای متغیرها و توابع.
  • قوانین استفاده از فضای سفید و نظرات.
  • شیوه های برنامه ریزی و اصول

استانداردهای کدگذاری ایمن:

  • قابلیت خواندن کد را بهبود می بخشد
  • اصلاح و نگهداری کد را ساده تر کنید

توافقنامه های کد گذاری می تواند قوانین مستند برای تیم هایی باشد که پیروی می کنند، یا فقط می توانند عمل coding شخصی شما باشد.

این صفحه توصیف مفاهیم کلی کد جاوا اسکریپت مورد استفاده توسط W3Schools است.

شما همچنین باید فصل بعدی "بهترین شیوه ها" را بخوانید و یاد بگیرید چگونه از اجتناب از برنامه نویسی جلوگیری کنید.

نام متغیر

در وب مهراز ما از camelCase برای نام شناسه (متغیرها و توابع) استفاده می کنیم.

همه نامها با یک حرف شروع می شوند.

در پایین این صفحه، بحث مفصلی در مورد قوانین نامگذاری پیدا خواهید کرد.

firstName = "John";
lastName = "Doe";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);

فضاهای اطراف اپراتورها

همیشه فاصله ها را در اطراف اپراتور (= + - * /) قرار دهید و بعد از کاما:

var x = y + z;
var values = ["Volvo", "Saab", "Fiat"];

نشانه گذاری کد

همیشه از 4 فضای استفاده کنید تا از بلوک های کد استفاده کنید:

function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}

قوانین دستورات

قوانین عمومی برای دستورات ساده:

یک دستور ساده را با یک سیمکالون همیشه پایان دهید.

var values = ["Volvo", "Saab", "Fiat"];
var person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
};

مقررات عمومی برای دستورات پیچیده (ترکیب):

  • براکت باز در انتهای خط اول قرار دهید.
  • قبل از باز کردن براکت از یک فضای خالی استفاده کنید.
  • براکت بسته را بر روی یک خط جدید قرار دهید، بدون فضای پیشنهادی.
  • بیانیه ای پیچیده را ابهام زدایی نکنید.

تابع:

function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}

حلقه تکرار:

for (i = 0; i < 5; i++) {
x += i;
}

شرط:

if (time < 20) {
greeting = "Good day";
} else {
greeting = "Good evening";
}

قوانین شی

  • مقررات عمومی برای تعاریف شی:
  • براکت باز کردن در همان خط به عنوان نام شیء قرار دهید.
  • از کولون به جای یک فاصله بین هر دارایی و ارزش آن استفاده کنید.
  • از نقل قولها در اطراف مقادیر رشته استفاده کنید، نه در اطراف مقادیر عددی.
  • بعد از آخرین جفت ارزش دارایی یک کاما اضافه نکنید.
  • محدوده بستن را در یک خط جدید قرار دهید، بدون فضای پیشنهادی.
  • همیشه یک تعریف شئ را با یک semicolon متوقف کنید.
var person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
};

در یک خط اشیاء کوتاه را می توان فشرده کرد، با استفاده از فضاهای تنها بین خواص، مانند این:

var person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};

طول خط <80

برای خوانایی، از سطوح بیش از 80 کاراکتر اجتناب کنبد.

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

document.getElementById("demo").innerHTML =
"Hello Dolly.";

نامگذاری قرارداد ها

همیشه برای همه کد های خود یک نام انتخاب کنید. مثلا:

  • نام متغیر و عملکرد به عنوان camelCase نوشته شده است
  • متغیرهای جهانی نوشته شده در UPPERCASE (ما نمی خواهیم، اما کاملا معمول است)
  • ثابت (مانند PI) نوشته شده در UPPERCASE

اختلالات در HTML و CSS:

ویژگی های HTML5 می توانند با داده (data-quantity، data-price) شروع شوند.

CSS با استفاده از خطا در نام ویژگی (فونت اندازه).

موارد زیر:

بسیاری از برنامه نویسان ترجیح می دهند از آرم های زیر استفاده کنند (date_of_birth)، به ویژه در پایگاه های داده SQL.

موارد زیر را اغلب در اسناد پی اچ پی استفاده می شود.

PascalCase:

PascalCase اغلب توسط برنامه نویسان C ترجیح داده می شود.

camelCase:

camelCase توسط خود جاوا اسکریپت، توسط jQuery و دیگر کتابخانه های جاوا اسکریپت استفاده می شود.

اسامی را با علامت $ شروع نکنید. این شما را با بسیاری از اسامی کتابخانه های جاوااسکریپت با مشکل مواجه می کند.

بارگیری جاوا اسکریپت در HTML

استفاده از دستورالعمل ساده برای بارگیری اسکریپت های خارجی (ویژگی نوع لازم نیست):

>script src="myscript.js">>/script>

دسترسی به عناصر HTML

نتيجه استفاده از سبک هاي HTML غيرمتمرکز ممکن است به اشتباهات جاوا اسکریپت منجر شود.

این دو عبارت جاوا اسکریپت نتایج مختلفی تولید خواهند کرد:

var obj = getElementById("Demo")
var obj = getElementById("demo")

در صورت امکان، از همان قرارداد نامگذاری (به عنوان جاوا اسکریپت) در HTML استفاده کنید.

افزونه های فایل

فایل های HTML باید دارای پسوند .html باشد (نه .htm).
فایل های CSS باید یک پسوند css داشته باشند.
فایل های جاوا اسکریپت باید دارای پسوند .js باشد.

از حروف کوچک در نام فایل استفاده کنید

اکثر وب سرورها (Apache، Unix) در مورد نام فایلها حساسیت خاصی دارند:
london.jpg نمی تواند به عنوان London.jpg دسترسی پیدا کند.
سایر سرورهای وب (مایکروسافت، IIS) حساس به حساسیت نیستند:
london.jpg می تواند به عنوان London.jpg یا london.jpg دسترسی پیدا کند.
اگر از مخلوطی از حروف کوچک و بزرگ استفاده می کنید، باید کاملا سازگار باشید.
اگر از حساس به فایل حرکت می کنید، به یک سرور حساس به حروف، حتی خطاهای کوچک می تواند وب سایت شما را شکست دهد.
برای اجتناب از این مشکلات، همیشه از نام فایل های حروف کوچک (در صورت امکان) استفاده کنید.

کارایی

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

نظر شما

لطفا نام و نام خانوادگی خود را وارد کنید
لطفا ایمیل خود را وارد کنید لطفا ایمیل صحیح وارد کنید.
لطفا متن نظر خود را وارد کنید
>

یادگیری JavaScript

مقالات و دروس

عضویت در خبرنامه شرکت نرم افزاری وب مهراز

برای اطلاع از بسته ها ، تخفیف های استثنایی و تازه های ما به خبرنامه وب مهراز بپیوندید.

لطفا شماره همراه صحیح وارد کنید.
لطفا ایمیل صحیح وارد کنید.

مقالات مرتبط