
// ואחריו הטקסט. מה שכתוב בשורה הזאת הוא הערה בלבד./* וסוגרים ב-*/. ההערה יכולה להתפרס על כמה שורות./** וסוגרים ב-*/, בדרך כלל מעל פונקציה או קלאס. Eclipse משתמשת בתיעוד הזה ומציגה אותו במקומות אחרים בסביבה. נלמד זאת לעומק כשנכתוב פונקציות.הטקסט המלא של הדקות הראשונות בהרצאה «Adding Comments» בקורס הווידאו של PracticU – כתוביות בעברית עם זמן התחלה לכל פסקה. כך תוכלו לקרוא ולחפש את הנושאים לפני שמתחילים ללמוד.
כאשר המתכנת כותב קוד הרבה פעמים קורה שהוא רוצה לכתוב לעצמו איזשהו הסבר מסוים לגבי מה הקוד שהוא כתב. הדבר הזה נקרא תיעוד או באנגלית comment. זה בעצם אפשרות לכתוב הערות במהלך הקוד כך שהוא כשהוא יקרא את הקוד הוא יבין יותר טוב מה הוא כתב וכמובן גם כשאנשים אחרים קוראים לנו את הקוד הם יכולים להבין יותר טוב מה כתבנו.
איך אנחנו יכולים לבצע תיעוד בג'אווה? אז תיעוד מתבצע באחת מסדרת דרכים. אם אנחנו רוצים לכתוב תיעוד של שורה אחת, אז אנחנו רושמים backslash, סליחה, slash-slash וכאן אנחנו רושמים את התיעוד שאנחנו רוצים, לדוגמה printing some escape characters ואנחנו יכולים לשים פה נקודותיים, אנחנו יכולים לשים את זה בצורה כזאת וזה אומר שמה שכתוב ממש מתחת
זה התיעוד שאנחנו כותבים, וזה מתאר את מה שיש מתחת. שיטה אחרת, זה אם אנחנו רוצים להגדיר מספר שורות של קומנט בבת אחת, אנחנו רושמים סלאש וכוכבית, ואז אנחנו יכולים לרדת ואנחנו רואים שכבר קליפס אומרת לנו שכל מה שאנחנו רושמים פה זה בעצם קומנט אחד שאנחנו יכולים לרשום במספר שורות.
לדוגמה, printing some more escaped characters which Eclipse doesn't know. ואנחנו רואים שהשורה הזאת באמת קצת ארוכה אז אנחנו יכולים לרדת והנה יש לנו אפשרות לבצע מספר שורות בבת אחת אנחנו לא חייבים את הכוכביות באמצע אנחנו יכולים לעשות את זה בצורה כזאת אנחנו יכולים להגדיר את זה אפילו בצורה כזאת אבל בדרך כלל כן נהוג לתת ל Eclipse להשלים
את זה בצורה כזאת, גם כן זה משהו שהוא מקובל. תיעוד נוסף שקיים לנו זה תיעוד שמאפשר לנו לראות את הקטעי קוד שכתבנו בכל מיני מקומות אחרים בתוך Eclipse.
אנחנו עושים את התיעוד הזה בצורה של סלאש וכוכבית כוכבית, ואז יורדים שורה אבל יש מקומות ספציפיים שבהם אנחנו יכולים לכתוב את זה ואנחנו כותבים את זה למעשה מעל פונקציות ומעל קלאסים ואנחנו לא ממש יודעים כרגע איך