ਜਾਵਾਸਕ੍ਰਿਪਟ ਸਟਾਇਲ ਗਾਈਡਲਾਈਨ

ਤੁਹਾਡੇ ਸਾਰੇ ਜਾਵਾਸਕ੍ਰਿਪਟ ਪ੍ਰੋਜੈਕਟਾਂ ਲਈ ਹਰੇਕ ਵਾਰ ਇੱਕ ਹੀ ਕੋਡ ਸਮਾਨਤਾਵਾਂ ਵਰਤੋਂ ਕਰੋ。

ਜਾਵਾਸਕ੍ਰਿਪਟ ਕੋਡ ਸਮਾਨਤਾਵਾਂ

ਕੋਡ ਸਮਾਨਤਾਵਾਂ (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"
};

ਕੁਝ ਜ਼ਿਆਦਾ ਜ਼ਿਆਦਾ ਵਾਕਯਾਂ ਦੇ ਆਮ ਨਿਯਮ:

  • ਪਹਿਲੀ ਲਾਈਨ ਦੇ ਅੰਤ ਉੱਤੇ ਖੁੱਲ੍ਹਣ ਵਾਲੇ ਬਰੈਕੈਟ ਲਿਖੋ
  • ਖੁੱਲ੍ਹਣ ਵਾਲੇ ਬਰੈਕੈਟ ਦੇ ਪਹਿਲੇ ਉੱਤੇ ਇੱਕ ਖਾਲੀ ਜਗ੍ਹਾ ਵਰਤੋਂ ਕਰੋ
  • ਬੰਦ ਬਰੈਕੈਟ ਨੂੰ ਨਵੀਂ ਲਾਈਨ ਉੱਤੇ ਲਿਖੋ, ਬੇਲੇ ਖਾਲੀ ਜਗ੍ਹਾ ਦੇ ਬਿਨਾ
  • ਕੁਝ ਜ਼ਿਆਦਾ ਜ਼ਿਆਦਾ ਵਾਕਯ ਨੂੰ ਸੇਕਨਡ ਨਾ ਸਮਾਪਤ ਕਰੋ

ਫੰਕਸ਼ਨ:

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

آزمایش کنید

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

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

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

آیا باید در نام‌های متغیر از آن استفاده کنیم؟خط تیرهوحروف بزرگ کوهنوردی (camelCase)یاخط زیر (underscore)آیا؟

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

خط تیره در HTML و CSS:

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

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

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

خط زیر (underscore):

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

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

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

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

حروف بزرگ کوهنوردی (camelCase):

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

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

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

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

<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 ਐਕਸਟੈਂਸ਼ਨ

ਛੋਟੇ ਲਿਖਤ ਫਾਇਲ ਨਾਮ ਦਾ ਇਸਤੇਮਾਲ ਕਰੋ

ਮਿਆਰੀ ਵੈਬ ਸਰਵਰ (Apache, Unix) ਫਾਇਲ ਨਾਮ ਦੇ ਕੇਸ ਸੈਸਟਿਵ ਹਨ:

london.jpg ਲੰਦਨ.jpg ਦੇ ਰੂਪ ਵਿੱਚ ਪਹੁੰਚਿਆ ਨਹੀਂ ਜਾ ਸਕਦਾ ਹੈ。

ਹੋਰ ਵੈਬ ਸਰਵਰ (ਮਾਈਕਰੋਸਾਫਟ ਦਾ IIS) ਕੇਸ ਸੈਸਟਿਵ ਨਹੀਂ ਹਨ:

london.jpg ਲੰਦਨ.jpg ਜਾਂ london.jpg ਦੇ ਰੂਪ ਵਿੱਚ ਪਹੁੰਚਿਆ ਜਾ ਸਕਦਾ ਹੈ。

ਅਗਰ ਤੁਸੀਂ ਕੇਸ ਨੂੰ ਮਿਸ਼ਰਤ ਵਰਤੋਂ ਕਰਦੇ ਹੋ, ਤਾਂ ਤੁਸੀਂ ਸਖਤ ਰੂਪ ਨਾਲ ਲਗਾਤਾਰ ਅਤੇ ਇਕਸੁਰ ਰੱਖਣਾ ਚਾਹੀਦੇ ਹੋ।

ਅਗਰ ਤੁਸੀਂ ਸਾਈਟ ਨੂੰ ਕੇਸ ਸੈਸਟਿਵ ਸਰਵਰ ਤੋਂ ਕੇਸ ਸੈਸਟਿਵ ਸਰਵਰ ਤੱਕ ਟ੍ਰਾਂਸਫਰ ਕਰ ਦੇਣਗੇ, ਤਾਂ ਇਸ ਛੋਟੀ ਗਲਤੀ ਵੀ ਤੁਹਾਡੀ ਸਾਈਟ ਨੂੰ ਨੁਕਸਾਨ ਪਹੁੰਚਾ ਸਕਦੀ ਹੈ。

ਇਹ ਸਮੱਸਿਆਵਾਂ ਦੀ ਇਮਾਨਦਾਰੀ ਲਈ, ਹਰ ਸਮੇਂ ਛੋਟੇ ਲਿਖਤ ਫਾਇਲਾਂ ਦਾ ਇਸਤੇਮਾਲ ਕਰੋ (ਜੇਕਰ ਸੰਭਵ ਹੈ)。

ਪ੍ਰਦਰਸ਼ਨ

ਕੰਪਿਊਟਰ ਕੋਡ ਸਮਝੌਤੇ ਨੂੰ ਵਰਤਦੇ ਨਹੀਂ ਹਨ।ਮਿਆਰੀ ਬਹੁਤ ਸਾਰੇ ਨਿਯਮ ਪ੍ਰੋਗਰਾਮ ਦੇ ਚਲਣ ਉੱਤੇ ਪ੍ਰਭਾਵ ਪਾਉਂਦੇ ਨਹੀਂ ਹਨ。

ਛੋਟੇ ਸਕ੍ਰਿਪਟਾਂ ਲਈ, ਇੰਡੈਂਟੇਸ਼ਨ ਅਤੇ ਅਤਿਰਿਕਤ ਸਪੇਸ ਮਹੱਤਵਪੂਰਨ ਨਹੀਂ ਹਨ。

ਡਿਵੈਲਪਮੈਂਟ ਵਿੱਚ ਦਿੱਤੇ ਗਏ ਸਕ੍ਰਿਪਟਾਂ ਲਈ, ਪਹਿਲੀ ਥਾਂ ਪੜ੍ਹਣਯੋਗਤਾ ਨੂੰ ਪ੍ਰਾਥਮਿਕਤਾ ਦੇਣੀ ਚਾਹੀਦੀ ਹੈ।ਵੱਡੇ ਉਤਪਾਦਕ ਸਕ੍ਰਿਪਟਾਂ ਨੂੰ ਛੋਟਾ ਕਰਨਾ ਚਾਹੀਦਾ ਹੈ。