مقدمه
با عرض سلام و وقت بخیر خدمت کاربران سایت پی وی لرن ، هر یک از زبان های برنامه نویسی محبوب از یک سینتکس و قواعد خاصی برای خوانایی بهتر و بهینه کردن کدها استفاده می کنند، در جاوا اسکریپت نیز قواعد و اصول مشخصی برای کد نویسی در ساختارهای مختلف آن ارائه شده است، در این بخش ما قصد داریم به بررسی قواعد کدنویسی در جاوا اسکریپت برای افزایش خوانایی و بهینه کردن کدهای برنامه بپردازیم. پس در ادامه ی این بخش با موضوع بررسی قواعد کدنویسی در جاوا اسکریپت با ما همراه باشید.
قواعد کدنویسی در جاوا اسکریپت
در ادامه ی این مبحث شما را با قواعد کدنویسی در جاوا اسکریپت در ساختارهای مختلف آن آشنا خواهیم کرد.
مروری بر قواعد کدنویسی در جاوا اسکریپت
قواعد کدنویسی، دستورالعمل های خاص برای برنامه نویسی هستند. آنها معمولا شامل موارد زیر می شوند:
- نامگذاری و اعلام قوانین برای متغیرها و توابع.
- قوانین استفاده از فضای سفید، فاصله ها، و توضیحات.
- شیوه های برنامه ریزی و اصول آن.
استانداردهای کدگذاری ایمن کیفیت:
- قابلیت خواندن کد را بهبود می بخشد.
- تعمیر و نگهداری کد را ساده تر می کند.
قواعد کدنویسی در جاوا اسکریپت می تواند قوانین مستند برای تیم هایی باشد که پیروی می کنند، یا فقط می توانند عمل coding شخصی شما باشد.
نام متغیرها
تمام نام ها با یک حرف شروع می شوند.
در پایین این صفحه، بحث مفصلی در مورد قوانین نامگذاری پیدا خواهید کرد.
مثال :
| firstName = "John"; lastName = "Doe"; price = 19.90; tax = 0.20; fullPrice = price + (price * tax); |
فضای خالی اطراف عملگرها
همیشه اطراف عملگرها ( = + – * / ) فضای خالی در نظر بگیرید.
مثال :
| var x = y + z; var values = ["Volvo", "Saab", "Fiat"]; |
دندانه گذاری کد
اصول دندانه گذاری کدها را رعایت کنید، به این معنی که مقداری فرورفتگی در کدهای داخلی بلوک نسبت به کدهای خارجی جهت خوانایی بهتر ایجاد کنید.
مثال :
| function toCelsius(fahrenheit) { return (5 / 9) * (fahrenheit - 32); } |
نکته : از tab برای دندانه گذاری استفاده نکنید، چراکه ادیتورهای مختلف tab ها را به صورت های مختلف تفسیر می کنند.
قوانین دستورات
قوانین عمومی برای کدنویسی ساده :
همیشه انتهای دستورات را با سمی کالون (;) مشخص کنید.
مثال :
| 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"}; |
طول خطوط کد کمتر از ۸۰ کاراکتر باشد
برای خوانایی بهتر از خطوط بیش از ۸۰ کاراکتر اجتناب شود.
اگر یک دستور جاوا اسکریپت در یک خط قرار نگیرد، بهترین مکان برای شکستن آن، پس از عملگر یا کاما است.
قواعد نامگذاری
در تمام کدنویسی های خود از قواعد یکسان برای نام گذاری استفاده کنید :
- متغیرها و توابع را به صورت camelCase نامگذاری کنید.
- متغیرها عمومی را با حروف بزرگ مشخص کنید.
- ثابت ها را (مانند PI) با حروف بزرگ مشخص کنید.
خطوط HTML و CSS
صفات HTML5 می تواند با یک -data شروع شود ( data-quantity, data-price ).
CSS نیز از hyphenها در نام گذاری خصوصیات خود استفاده می کند (به عنوان مثال font-size).
نکته : Hyphens ها ممکن است که به جای تفریق اشتباه گرفته شود. Hyphens ها در نام های جاوا اسکریپت مجاز نیستند.
زیر خط دار
بیشتر برنامه نویسان سعی می کنند از زیر خط دار (مثلا date_of_birth) بخصوص در دیتابیس های SQL استفاده کنند.
زیر خط دارها معمولا در اسناد PHP نیز استفاده می شوند.
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 دسترسی پیدا کرد.
اگر از مخلوطی از حروف کوچک و بزرگ استفاده می کنید، باید بسیار سازگار باشید.
اگر از سرور حساس به حروف استفاده می کنید، حتی خطاهای کوچک می تواند وب سایت شما را شکست دهد.
برای اجتناب از این قبیل مشکلات، همیشه سعی کنید از نام هایی با حروف کوچک (در صورت امکان) استفاده کنید.
کارایی
قواعد کدنویسی در جاوا اسکریپت توسط رایانه ها استفاده نمی شود. اکثر قوانین تأثیر کمی در اجرای برنامه دارند.
فاصله انداختن و فضای اضافی در اسکریپت های کوچک قابل توجه نیست.
برای کدنویسی در توسعه ی برنامه ها، بیشتر باید خوانایی کد مد نظر باشد. اسکریپت های بزرگ نیز باید بهینه شوند.
کلام آخر
یکی از نکات ساده اما مهمی که توصیه می شود در هر زبان برنامه نویسی رعایت شد، رعایت کردن قواعد کدنویسی آن زبان می باشد، چرا که این کار خوانایی کد را افزایش داده و همچنین کدها بهینه می شوند. این مبحث در جاوا اسکریپت نیز حائز اهمیت است، از این رو در این بخش به بررسی کلی قواعد کدنویسی در جاوا اسکریپت پرداختیم.
فروشگاه
فیلم های آموزشی
کتاب های آموزشی
مقالات آموزشی
وردپرس
