راهنمای استایل و استانداردهای کدنویسی

از ویکی‌کد
پرش به ناوبری پرش به جستجو
Main Page Tutorial
JavaScript-menu.png
موارد آموزشی
فرم‌ها در جاوا اسکریپت
اشیاء در جاوا اسکریپت
تابع در جاوا اسکریپت
HTML DOM در جاوا اسکریپت
Browser BOM در جاوا اسکریپت
AJAX در جاوا اسکریپت
JSON در جاوا اسکریپت
جی‌کوئری در برابر جاوا اسکریپت
مرجع جاوا اسکریپت

همیشه از یک استاندارد مشابه در تمامی پروژه‌های جاوا اسکریپت خود استفاده کنید. [۱]

استانداردهای کدنویسی در جاوا اسکریپت

استانداردهای کدنویسی شیوه های طراحی برای برنامه نویسی هستند. آنها به طور معمول شامل موارد زیر می‌شوند:

  • نام گذاری و قوانین تعریف کردن متغیرهاو توابع
  • قوانین برای استفاده از فضای خالی، فاصله‌های اول خطوط (به انگلیسی: indentation) و نظرات (به انگلیسی: comments)
  • تمرین‌ها و الگوهای برنامه‌نویسی

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

  • موجب بهبود خوانایی کد می‌شود
  • فرایند بهبود دادن کدها را آسان‌تر می‌کند

استانداردهای کدنویسی را می‌توان به صورت سندهایی برای اعضای تیم اجرا کرد که اعضای تیم از آنها تبعیّت کنند یا تمرین برنامه‌نویسی شما باشند.

این صفحه شیوه کدنویسی استانداردی که توسط Wikicod استفاده می‌شود را توضیح می‌دهد.

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

نام متغیرها

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

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

در پایین این صفحه شما مطالب گسترده‌تری را در مورد قوانین نامگذاری خواهید آموخت.

1 firstName = "John";
2 lastName = "Doe";
3 
4 price = 19.90;
5 tax = 0.20;
6 
7 fullPrice = price + (price * tax);

فضای خالی بین عملگرها

همیشه دور و اطراف عملگرها ( = + - * / )، و بعد از ویرگول‌ها از فضای خالی استفاده کنید:

مثال

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

Indent یا فاصله اول خطوط در کدنویسی

همیشه از ۲ فضای خالی Space Space برای indent یا فاصله اول خطوط کد بلاک استفاده کنید:

توابع:

1 function toCelsius(fahrenheit) {
2   return (5 / 9) * (fahrenheit - 32);
3 }
از Tab یا tabulatorها برای indentها استفاده نکنید. ویرایشگرهای مختلف indentها را به صورت‌های مختلف نمایش می‌دهند.

قوانین عبارت ها

قوانین اصلی برای عبارت‌های برنامه‌نویسی ساده عبارتند از:

  • همیشه یک عبارت ساده با نقطه ویرگول یا سمی کالن ; به پایان می‌رسد

مثال

1 var values = ["Volvo", "Saab", "Fiat"];
2 
3 var person = {
4   firstName: "John",
5   lastName: "Doe",
6   age: 50,
7   eyeColor: "blue"
8 };

قوانین اصلی برای عبارت‌های پیچیده (ترکیبی) عبارتند از:

  • بازکردن براکت در انتهای خط اول {
  • استفاده از یک Space قبل از بازکردن براکت
  • بستن براکت } بدون استفاده از فضای خالی خاص
  • به پایان نبردن یک عبارت پیچیده با استفاده از ; یا سمیکالن

توابع:

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

حلقه ها:

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

جملات شرطی:

1 if (time < 20) {
2   greeting = "Good day";
3 } else {
4   greeting = "Good evening";
5 }

قوانین اشیاء

قوانین اصلی برای تعریف اشیاء عبارتند از:

  • باز کردن براکت { در خط مشترک با نام شیء
  • استفاده از فاصله Space بین هر ویژگی و مقدار آنها
  • استفاده از علامت کوتیشن ' برای مقدار رشته‌ای، نه برای مقادیر عددی
  • اضافه نکردن ویرگول , بعد از آخرین جفت ویژگی–مقدار
  • قرار دادن براکت بسته } دریک خط جدید بدون استفاده از فضای خالی خاصی
  • همیشه به پایان بردن تعریف شیء با نقطه ویرگول یا سمیکالن ;

مثال

1 var person = {
2   firstName: "John",
3   lastName: "Doe",
4   age: 50,
5   eyeColor: "blue"
6 };

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

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

طول هر خط ۸۰ <

برای خوانایی بیشتر کدتان سعی کنید، از نوشتن بیش از ۸۰ کاراکتر در هر خط بپرهیزید.

اگر یک عبارت جاوا اسکریپت در یک خط جا نگرفت، بهترین مکان برای ایجاد فاصله و رفتن به خط بعدی، بعد یک عملگر یا یک ویرگول , است.

مثال

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


مشاهدهٔ نتیجه


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

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

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

آیا لازم است که شما از روش خط‌تیره -، کوهان شتری یا زیرخط _ در نام متغیرها استفاده کنید؟

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

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

ویژگی‌های (به انگلیسی: attributes) HTML5 می‌توانند با data- همانند (data-quantity و data-prrice) شروع شوند.

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

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

زیرخط _:

بسیاری از برنامه نویسان ترجیح می‌دهند از علامت زیر خط (همانند date_of_birth) به خصوص در دیتابیس SQL استفاده کنند.

علامت زیرخط _ معمولا در سند سازی‌های php نیز استفاده می‌شود.

روش نامگذاری پاسکال:

روش پاسکال معمولاً توسط برنامه نویسان زبان سی استفاده می‌شود.

روش کوهان شتری:

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

نام‌ها را با علامت $

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

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

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

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

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

در نتیجه استفاده مرتب از سبک‌های (به انگلیسی: styles) HTML ، ممکن است منجر به خطاهای JavaScript شود.

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

1 var obj = getElementById("Demo")
2 
3 var obj = getElementById("demo")

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

مشاهده راهنمای استایل‌ها در HTML.

فرمت فایل ها

فایل‌های HTML فرمت html. دارند (نه فرمت htm.)

فایل‌های CSS معمولاً فرمت css. دارند.

فایل‌های JavaScript، فرمت js. دارند.

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

بسیاری از وب سرورها (آپاچی، یونیکس) درمورد نام فایل‌ها حساس به حروف کوچک و بزرگ هستند:

فایل london با فایل London.jpg را نمی‌توان به یک روش مشابه دسترسی داشت.

سایر وب سرورها (مایکروسافت، IIS) حساس به حروف کوچک و بزرگ نیست.

به فایل london.jpg می‌توان همانند فایل‌های London.jpg یا london.jpg دسترسی داشت.

اگر شما حروف کوچک و بزرگ را با یکدیگر در نام فایل‌ها ترکیب کنید، شما می‌بایست نام فایل را به صورت دقیق بنویسید.

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

برای جلوگیری از این مشکلات، همیشه از حروف کوچک (در صورت امکان) در نامگذاری آن استفاده کنید.

کارایی

قوانین کدنویسی توسط رایانه‌ها استفاده نمی‌شود. بیشتر قوانین تأثیر اندکی روی اجرای برنامه‌ها دارند.

فاصله از ابتدای خطوط و فواصل اضافی در اسکریپت‌های کوچک مهم نیستند.

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


منابع آموزشی