הערות ב- JavaScript

• מאי 3, 2024

ההערות הן בדיוק זה, הערות ששמת ב- JavaScript או ב- HTML כדי להסביר את המתרחש. ישנן מספר דרכים להכניס הערות בקוד JavaScript שלך. תחביר תגובה - כיצד לומר לתסריט או למסמך שמשהו הוא הערה ולא נתונים או קוד - הוא פשוט מאוד. כתיבת הערות טובות קשה יותר ומתוך התבוננות בקוד (שלי משולב) נראה שהחלק הכי קשה הוא בעצם עושה את זה!

ל- JavaScript יש שני סוגים של הערות, תגובה בשורה אחת והערה מרובת שורות.

הערת השורה היחידה ב- JavaScript מתחילה בשני חתכים קדימה (//) ומסתיימת בסוף הקו (טכנית, מיד לפני תו מסיים הקו). הערות בשורה אחת שימושיות במיוחד עבור הערות קצרות.

// זוהי תגובה בשורה אחת
data = "הנתונים שלי" // גם זו תגובה בשורה אחת

הערה מרובת שורות ב- JavaScript מתחילה עם קו נטוי קדימה ואחריו כוכבית (/*) ומסתיים בכוכבית ואחריה קו נטוי קדימה (*/). הכל בין /* ו */ נחשב כהערה. תגובה מסוג זה יכולה להשתרע על מספר שורות. אפשר גם לשים הערה מסוג זה באמצע שורת קוד, אם היא אינה משתרעת על מספר שורות, אך לעיתים רחוקות זה מועיל.

/ * זו שורה אחת של הערה מרובת שורות
זה עדיין חלק מההערה שלי
זה החלק האחרון של התגובה שלי * /

/ * זו הערה בסגנון רב-קו בשורה יחידה * /

לעתים קרובות אתה רואה כוכביות נוספות שנוספות לתגובות מרובות שורות ליצירת תיבות מידע דקורטיביות, כגון:

/*********************
* הפונקציות שלי *
*********************/

פונקציות רב-שורות שימושיות במיוחד בתחילת תוכנית או קטע בתוכנית כדי לתאר מה התכנית מיועדת לעשות ואיך היא עושה זאת.

ההערות משמשות לשתי מטרות. כשאתה כותב קוד (או אפילו לפני שאתה כותב אותו!), עליך לכתוב הערות שיאפשרו לאדם אחר להבין מה התוכנית עושה (או אמור לעשות.) גם אם אתה לא מצפה מאף אחד אחר לקרוא אי פעם הקוד שלך, תופתע כמה אתה יכול לשכוח אם ברצונך לבצע שינויים לאחר מספר שבועות או חודשים.

כמו כן, במיוחד בשפות סקריפטים כמו JavaScript, לעתים קרובות משתמשים בתגובות כחלק מתהליך הבאגינג. אתה יכול להכניס קוד שישמש לניפוי באגים ולהגיב להם כשתסיים להשתמש בהם או להעיר קטעי קוד שלדעתך גורמים לבעיות או משתנים להוסיף פונקציונליות חדשה. כשאתה עושה זאת, הקפד במיוחד לא לשים הערת שורה אחת על הקו מול תחילת הערה מרובת שורות. זה מבטל את שאר ההערות הרב-שורות, מה שבוודאי יגרום לשגיאה.

הוראות וידאו: Comments in JavaScript (מאי 2024).