PracticU

Adding Comments

בלי כתוביותעם כתוביות
PracticU › קורס יסודות התכנות - שפת JAVA - קורס ג'אווה למתחילים › Adding Comments
Adding Comments
הערות (Comments) הן טקסט שנכתב בתוך הקוד כדי להסביר אותו. הקומפיילר מתעלם מהן, אבל הן עוזרות למתכנת ולמי שקורא את הקוד אחריו.
שלוש דרכי תיעוד
1. הערה בשורה אחת: כותבים // ואחריו הטקסט. מה שכתוב בשורה הזאת הוא הערה בלבד.
2. הערה בכמה שורות: פותחים ב-/* וסוגרים ב-*/. ההערה יכולה להתפרס על כמה שורות.
3. תיעוד לפונקציות ולקלאסים: כותבים /** וסוגרים ב-*/, בדרך כלל מעל פונקציה או קלאס. Eclipse משתמשת בתיעוד הזה ומציגה אותו במקומות אחרים בסביבה. נלמד זאת לעומק כשנכתוב פונקציות.
שימו לב
לא צריך לתעד כל שורה. כדאי לתעד מקומות מורכבים בקוד, או מקומות שקשה להבין בקריאה ראשונה, ולעיתים קרובות מתעדים מעל פונקציות.
כשמתעדים בצורה נכונה, הקוד קל יותר לקריאה, גם לכם וגם לאחרים.
השיעור הבא בקורס: תרגול לפרק של Console Output
מילון מושגים:
הערה – טקסט בקוד שמסביר אותו לבני אדם ואינו מבוצע על ידי המחשב.
קומפיילר – תוכנה שממירה קוד מקור שנכתב בשפת תכנות לקוד שהמחשב יכול להריץ, ומדווחת על שגיאות תחביר.
פונקציה – קטע קוד בעל שם שמבצע משימה מוגדרת, מקבל ערכי קלט (פרמטרים) ויכול להחזיר תוצאה. מאפשרת לארגן קוד ולהשתמש בו שוב.

פרקי ההרצאה: Adding Comments

  1. 00:00

    מהו תיעוד Comment והערה בשורה אחת

  2. 01:00

    הערה על מספר שורות בסלאש כוכבית

  3. 01:44

    צורת כתיבה נפוצה של הערה ארוכה

  4. 02:23

    תיעוד Javadoc מעל מחלקות ופונקציות

תמלול ההרצאה: Adding Comments

הטקסט המלא של הדקות הראשונות בהרצאה «Adding Comments» בקורס הווידאו של PracticU – כתוביות בעברית עם זמן התחלה לכל פסקה. כך תוכלו לקרוא ולחפש את הנושאים לפני שמתחילים ללמוד.

  1. 00:02

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

  2. 00:30

    איך אנחנו יכולים לבצע תיעוד בג'אווה? אז תיעוד מתבצע באחת מסדרת דרכים. אם אנחנו רוצים לכתוב תיעוד של שורה אחת, אז אנחנו רושמים backslash, סליחה, slash-slash וכאן אנחנו רושמים את התיעוד שאנחנו רוצים, לדוגמה printing some escape characters ואנחנו יכולים לשים פה נקודותיים, אנחנו יכולים לשים את זה בצורה כזאת וזה אומר שמה שכתוב ממש מתחת

  3. 01:03

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

  4. 01:30

    לדוגמה, printing some more escaped characters which Eclipse doesn't know. ואנחנו רואים שהשורה הזאת באמת קצת ארוכה אז אנחנו יכולים לרדת והנה יש לנו אפשרות לבצע מספר שורות בבת אחת אנחנו לא חייבים את הכוכביות באמצע אנחנו יכולים לעשות את זה בצורה כזאת אנחנו יכולים להגדיר את זה אפילו בצורה כזאת אבל בדרך כלל כן נהוג לתת ל Eclipse להשלים

  5. 02:06

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

  6. 02:29

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

לקורס המלא: קורס ג'אווה למתחילים אונליין

ההרצאה הקודמת: Escaped Character

ההרצאה הבאה: תרגול לפרק של Console Output

הרצאות קשורות מקורסים אחרים

  • Master Details - Adding Fragments

קורסים נוספים במסלול

  • קורס מבוא ל-QA - מידע חשוב לבודק תוכנה
  • קורס פוסטמן - Postman - בדיקות לאתרי אינטרנט - API
  • קורס Robot Framework - בדיקות QA ממשק גרפי
  • קורס סלניום בסיסי - בדיקות אוטומטיות - Selenium
  • קורס סלניום מתקדם - CI/CD - Continues Integration
  • קורס מייבן - Maven