جاوا اسکریپٹ کی کوالٹی رہنمائی

آپ کی تمام جاوا اسکریپٹ پروجیکٹوں کے لئے ہمیشہ ایک جیسی کھلاسا استعمال کریں

جاوا اسکریپٹ کی کھلاسا

کد کی کھلاسا (Coding conventions) کا مطلب یہ ہےپرورش کی کھلاسا کی رہنمائییہ اصول عموماً شامل ہوتے ہیں:

  • ویرائی اور فنکشن کی نام کاری اور اعلان کی قوانین
  • اسپیس، ایندرتنگ اور کمرش کے قوانین کا استعمال
  • پرورش کی عادت اور اصول

کد کی کھلاساکوالٹی کو یقینی بنانا:

  • کد کی پڑھائی کو بہتر بنانا
  • کد کی دیکھ بھال کو بہتر بنانا

کد کی کھلاسا کی کھلاسا کیا جاسکتا ہے کہ یہ تیم کی کسی مکمل رول یا آپ کی اپنی کد کی عادت ہو سکتی ہے۔

اس صفحے پر CodeW3C.com پر استعمال کئے جانے والے عام جاوا اسکریپٹ کی کھلاسا کی معرفی کی گئی ہے۔

آپ کوئی بھیج سکتا ہیں کہ آپ نئی سیکشن کا پڑھنا جائیں 'بہترین طریقہ کار'، تاکہ آپ کو کد کی بندوبست میں کچھ مشکل کا مواقع سنبھالتا جائے۔

نام متغیر

در CodeW3C.com، ما از نام‌های شناسه‌ای (متغیرها و توابع) با استفاده ازحروف اول بزرگ و بعدی کوچک。

تمام نام‌ها باحرفآغاز.

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

firstName = "Bill";
lastName = "Gates";
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: "Bill",
     lastName: "Gates",
    age: 50,
    eyeColor:  "blue"
};

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

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

دستورالعمل:

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";
}

قوانین شیء

قوانین عمومی تعریف شیء:

  • دوپایه باز را با نام شیء در یک خط قرار دهید
  • در هر ویژگی و ارزش از یک دوپایه با یک فضای خالی استفاده کنید
  • در پشت ارزش آخرین جفت ویژگی و ارزش، کاما ننویسید
  • در یک خط جدید، کلمه بسته را بنویسید، بدون فضای پیش‌درآمد
  • همیشه با نقطه ویرایش تعریف شیء را تمام کنید

مثال

var person = {
    firstName: "Bill",
    lastName: "Gates",
    age: 19,
    eyeColor:  "blue"
};

شاید می‌توانید یک شیء کوچک را در یک خط فشرده کنید، فقط بین ویژگی‌ها از فضای خالی استفاده کنید، مانند این:

var person = {firstName:"Bill", lastName:"Gates", age:50, eyeColor:"blue"};

طول خط کمتر از 80 کاراکتر

برای افزایش خوانایی، از طول هر خط بیش از 80 کاراکتر خودداری کنید.

اگر طول خطه‌های JavaScript از یک خط بیشتر شود، بهترین مکان برای تغییر خط، پس از علامت عملگر یا کاما است.

مثال

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

به طور مستقیم امتحان کنید

قوانین نام‌گذاری

لطفاً همیشه از قوانین نام‌گذاری مشابه برای تمام کد خود استفاده کنید. به عنوان مثال:

  • نام‌های متغیر و تابع با استفاده ازحروف ایتالیکبرای نوشتن
  • متغیرهای جهانی با استفاده ازحروف بزرگ(ما این کار را نمی‌کنیم، اما بسیار شایع است)
  • ثابت‌ها (مثل PI) با استفاده ازحروف بزرگ

آیا باید از آن در نام‌های متغیر استفاده کنیم؟خط تیرهوحروف ایتالیکیاخط زیر علامت خطیآیا؟

این یکی از موضوعات رایج در بحث‌های برنامه‌نویسان است. پاسخ بستگی به کسی دارد که آن را پاسخ می‌دهد:

استفاده از خط تیره در HTML و CSS:

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

CSS از خط تیره در نام‌های ویژگی‌ها استفاده می‌کند (font-size).

خط تیره ممکن است به عنوان علامت ضرب اشتباه گرفته شود. استفاده از خط تیره در نام‌گذاری JavaScript مجاز نیست.

خط زیر علامت خطی:

بسیاری از برنامه‌نویسان از خط زیر علامت خطی (date_of_birth) استفاده می‌کنند، به ویژه در پایگاه‌های داده SQL.

خط زیر علامت خطی اغلب در منابع PHP استفاده می‌شود.

روش نام‌گذاری Pascal (PascalCase):

برنامه‌نویسان زبان C اغلب از روش نام‌گذاری Pascal استفاده می‌کنند.

حروف ایتالیک (camelCase):

JavaScript خود، jQuery و سایر کتابخانه‌های JavaScript از حروف ایتالیک استفاده می‌کنند.

نام‌گذاری JavaScript نباید با علامت $ شروع شود. این ممکن است منجر به تداخل نام‌های JavaScript شود.

بارگذاری JavaScript در HTML

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

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

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

پیامدهای استفاده از سبک HTML ناخوشایند، شاید باعث خطاهای JavaScript شود.

این دو خط JavaScript نتایج متفاوتی ایجاد می‌کنند:

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

اگر ممکن است، لطفاً در HTML از قوانین نام‌گذاری مشابه استفاده کنید (مثل JavaScript).

访问 HTML 样式指南。

文件扩展名

HTML 文件应该使用 .html 扩展名（而非 .htm）。

CSS 文件应该使用 .css 扩展名。

JavaScript 文件应该使用 .js 扩展名。

使用小写文件名

大多数 web 服务器（Apache、Unix）对文件名的大小写敏感：

london.jpg 无法视作 London.jpg 进行访问。

其他 web 服务器（微软的 IIS）对大小写不敏感：

london.jpg 能够以 London.jpg 或 london.jpg 来访问。

如果您混合使用大小写，则必须严格保持连续和一致。

如果您将站点从大小写不敏感的服务器转移至对大小写敏感的服务器，即使这种小错误也可能破坏您的网站。

为了避免这些问题，请始终使用小写文件名（如果可能）。

性能

计算机不会使用代码约定。大部分规则对程序的执行影响很小。

缩进和额外的空格对小段脚本并不重要。

对于开发中的脚本，应该优先考虑可读性。应该缩小更大型的生产脚本。