Documenting a Function

תמלול ההרצאה: Documenting a Function

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

1. 00:04

   ראינו בעבר כל מיני שיטות לתעד את הקוד שלנו וראינו גם שזה מאוד חשוב לתעד את הקוד. יש שיטה מאוד מיוחדת לתעד פונקציות. קודם כל, איזה סוגי תיעוד כבר ראינו? אז אנחנו יכולים לעשות דבר כזה וזה בעצם לבצע תיעוד בשורה אחת בלבד comment בשורה אחת This is our main method ואנחנו יכולים לכתוב דבר כזה

2. 00:35

   ואז לתעד מספר שורות קוד This is a comment in several lines. כמובן שאלה לא חובה, מספיק בהתחלה אחד כזה ובסוף אחד כזה ויש לנו פה אפשרות לתעד מספר שורות.

3. 00:55

   אבל איך אנחנו יכולים לעשות תיעוד מאוד מעניין לפונקציות? בואו ניקח פה פונקציה static void print something ונשלח לה int message בואו נקרא לזה print message.

4. 01:15

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

5. 01:43

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

6. 01:56

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

7. 02:07

   Printing some message on the console. השורה הבאה זה הפרמטרים השונים. השורות הבאות זה הפרמטרים. Message זה הפרמטר Message. בואו נתעד אותו.

8. 02:20

   The message to print. בואו נבצע את אותו הדבר על הפונקציה. סלאש כוכבית כוכבית enter והפונקציה עצמה מה שהיא עושה זה Getting the maximum number among two arguments A the first number to check B the second number to check ומה אנחנו מחזירים Returns the max number ויש לנו כרגע תיעוד כזה.

9. 03:06

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

10. 03:31

    יש לכם את התיעוד בפנים בחוץ הוא יודע בדיוק איך הפורמט הנכון לבצע. דבר שני כאשר אנחנו קוראים לפונקציה כזאת בואו נקרא לפונקציה הראשונה printMessage, פותחים סוגריים ולוחצים על Control Space, נפתח לנו כאן בצד את התיעוד ואנחנו רואים מה הפונקציה עושה Printing Some Message on the Console ואת הפרמטרים של ה-Message, The Message to Print.

11. 04:01

    בואו נשלח כאן איזשהו מסג' Hello, בואו נקרא לפונקציה השנייה Max, Get Max, פותחים סוגריים, Control Space ואנחנו רואים כאן את כל התיעוד לגבי זה, כולל מה הפרמטרים מקבלים, מה התיעוד לגביהם, כולל התיעוד לגבי הערך

12. 04:22

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

13. 04:32

    אז זה דבר מאוד מעניין. בואו נגדיר את זה בצורה כזאת. נדפיס. למה יש לי שגיאה על printMessage?

14. 04:45

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

15. 05:17

    כדאי שהן יהיו בעלות הרשאת גישה public. מה זה בדיוק הרשאת גישה? אפשר ללמוד את זה במודול Object Oriented Programming, תכנות מונחה עצמים, אבל זה אומר שאנחנו חושפים את הפונקציות האלה כך שהן יהיו ניתנות לשימוש גם מתוך מערכות אחרות, פרויקטים אחרים,

16. 05:39

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

17. 06:00

    זה נקרא Java Docs, הדוקומנטציה לגבי Java עצמה, וכמובן אנחנו כותבים Java, אנחנו יכולים לשלב