از طریق منوی جستجو مطلب مورد نظر خود در وبلاگ را به سرعت پیدا کنید
نوشتن کد در جاوا اسکریپت – انواع و بهترین روش ها هدف اصلی از نوشتن کد این است که رایانه بتواند آن را به عنوان دستور تفسیر کند. با این حال، همچنین مهم است که کدی که می نویسیم به راحتی توسط توسعه دهندگان همکار قابل تفسیر باشد. آیا تا به حال به پروژه ای برگشته اید و در درک منطق داخلی مشکل داشته اید؟ خب احتمالا…
سرفصلهای مطلب
معرفی
هدف اصلی از نوشتن کد این است که کامپیوتر بتواند آن را به عنوان دستور تفسیر کند. با این حال، همچنین مهم است که کدی که می نویسیم به راحتی توسط توسعه دهندگان همکار قابل تفسیر باشد.
آیا تا به حال به پروژه ای برگشته اید و در درک منطق داخلی با مشکل مواجه شده اید؟ خوب احتمالاً به این دلیل است که پروژه گفته شده انجام نشده است نظر داد به درستی.
نظرات یادداشت هایی نوشته شده در کد هستند که توسط موتور جاوا اسکریپت نادیده گرفته می شوند، به این معنی که به هیچ وجه بر خروجی تأثیر نمی گذارند. تنها هدف آنها این است که توضیح دهند که چگونه و چرا کد برای توسعه دهندگان دیگر و خودتان کار می کند.
در این مقاله به بررسی خواهیم پرداخت روش کامنت گذاشتن کد جاوا اسکریپت، انواع نظرات و برخی از بهترین شیوه ها.
نظرات تک خطی
کامنت های تک خطی معمولا برای نظر دادن استفاده می شوند بخشی از خط یا خط کامل کد. نظرات تک خطی در جاوا اسکریپت با شروع می شود //. مفسر همه چیز سمت راست این دنباله کنترل را تا انتهای خط نادیده می گیرد.
بیایید نمونه ای از یک نظر تک خطی را در عمل ببینیم:
// Print "Hello World" in the console
console.log("Hello World");
در اینجا، ما از یک کامنت تک خطی برای توصیف آنچه که خط بعدی کد انجام می دهد استفاده می کنیم.
اگر یک نظر تک خطی در انتهای یک خط کد ظاهر شود، آن را an می نامند نظر درون خطی.
اینها معمولاً برای افزودن حاشیه نویسی سریع استفاده می شوند:
let c = a + b; // Assign sum of a, b to c
نظرات چند خطی و جاوا اسکریپت DocStrings
اگر می‌خواهیم یادداشتی اضافه کنیم که در چندین خط پخش شده باشد، می‌توانیم نظرات چند خطی را انتخاب کنیم یا نظرات در سطح بلوک.
نظرات چند خطی با شروع می شود /* و به پایان برسد */:
/* The following program contains source code for a game called Tic-tac-toe.
It is a paper-and-pencil game for two players, X and O, who take turns marking the spaces in a 3×3 grid.
The player who succeeds in placing three of their marks in a horizontal, vertical, or diagonal row is the winner
*/
در اینجا، یک نظر چند خطی برای توصیف تیک تاک استفاده می شود. به طور کلی، نظرات چند خطی برای معرفی و توضیح بخشی از کد استفاده می شود، جایی که یک خط / جمله کافی نیست.
نوع دیگری از کامنت چند خطی نیز اغلب دیده می شود:
/**
* The following program contains source code for a game called Tic-tac-toe.
* It is a paper-and-pencil game for two players, X and O, who take turns marking the
* spaces in a 3×3 grid.
* The player who succeeds in placing three of their marks in a horizontal, vertical, or
* diagonal row is the winner
*/
اغلب اوقات، این نظرات می‌تواند شامل اطلاعاتی در مورد کد ادامه‌دهنده باشد، مانند پارامترهای یک تابع یا حتی نویسنده کد:
/**
* Function that greets a user
* @author John
* @param {String} name Name of the user
* @return {String} Greeting message
*/
function greetUser(name) {
return `Greetings, ${name}!`;
}
این نظرات به عنوان DocStrings، زیرا اساساً رشته‌هایی (نظرات) هستند که مستندات کد شما را تشکیل می‌دهند.
این نوع نظرات برای سایر توسعه دهندگان تیم شما واقعا مفید است، زیرا می توانید مشخص کنید ورودی مورد انتظار چیست، خروجی چیست و همچنین در صورت نیاز با چه کسی تماس بگیرید.
یک مزیت اضافه این است که می توانید مستندات را بر اساس تولید کنید روی این DocStrings
استفاده از نظرات برای اشکال زدایی
علاوه بر یادداشت برداری، نظرات همچنین می توانند برای جلوگیری از اجرای سریع کد برای اهداف اشکال زدایی استفاده شوند. این امکان پذیر است زیرا موتورهای جاوا اسکریپت کدهای نظر داده شده را تفسیر نمی کنند. این به عنوان نامیده می شود نظر دادن کد.
اگر خط اشتباهی وجود داشته باشد که باعث ایجاد مشکل می شود، ما به سادگی می توانیم “نظر بده” برای غیرفعال کردن آن، بدون حذف خط. این را می توان با دیباگرهای واقعی جفت کرد تا به شما کمک کند آنچه را که در حال انجام است ارزیابی کنید روی.
کد زیر را در نظر بگیرید:
console.log("Working code");
console.log("Erroneous code);
اگر می‌خواهیم عبارت دوم را حذف کنیم، اما نمی‌خواهیم آن را برای همیشه حذف کنیم، می‌توانیم به سادگی آن را نظر دهیم:
console.log("Working code");
//console.log("Erroneous code);
نکته حرفه ای: در اکثر ویرایشگرهای کد، می توانیم از میانبر صفحه کلید استفاده کنیم Ctrl + / برای ویندوز و Cmd + / برای مک برای اظهار نظر یک خط کد.
علاوه بر این، اگر مطمئن نیستید که آیا آنها را حذف می کنید یا خیر، می توانید کل بخش ها را نظر دهید:
/*console.log("Entering for loop");
for (let i = 0; i < 100; i++) {
console.log(i);
}*/
شیوه های خوب اظهار نظر
اول از همه، نظر دادن بهانه ای برای نوشتن کدهای ناخوانا نیست، و سپس آن را با پنج پاراگراف کامنت توضیح دهید. ابتدا باید تمرکز کنیم روی نوشتن کد تمیز و خود توضیحی که بعداً می توان با نظرات سازنده آن را بهبود بخشید.
از نظرات برای توضیح استفاده کنید چرا تو یه کاری کردی نه چگونه توانجامش دادی. اگر متوجه شدید که توضیح می‌دهید که چگونه کاری را انجام داده‌اید، وقت آن است که یک قدم به عقب بردارید و کد خود را به یک چیز کاملاً واضح تبدیل کنید.
توصیه دیگر این است که از نوشتن نظراتی که واضح هستند و طبیعتاً اضافی هستند خودداری کنید. به عنوان مثال، نظر زیر کاملا غیر ضروری است:
// Prints out the result
console.log(result)
ابزارهای مفیدی وجود دارد، مانند JSDOC 3 که می تواند مستندات را تولید کند روی نظرات درون کد شما که به صورت DocStrings که در بالا ذکر شد فرمت شده اند.
نتیجه
در این مقاله به این موضوع پرداختیم که نظرات چیست و چگونه آنها را در جاوا اسکریپت ایجاد کنیم. ما انواع مختلفی از نظرات را بررسی کرده ایم – تک خطی و چند خطی نظرات، و همچنین جاوا اسکریپت Docstrings ذکر شده است.
ما همچنین دیدیم که چگونه کد خود را با استفاده از تکنیکی به نام “کامنت گذاشتن” اشکال زدایی کنیم و در نهایت برخی از شیوه های خوب اظهار نظر را خلاصه کرده ایم.
منتشر شده در 1403-01-18 14:17:05
