תיעוד של קוד

תמלול ההרצאה: תיעוד של קוד

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

1. 00:01

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

2. 00:28

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

3. 00:43

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

4. 01:03

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

5. 01:14

   אז בעולם ה-C-Sharp ישנן שלוש שיטות לבצע תיעוד של קוד שאנחנו כותבים. שיטה ראשונה, נניח שאנחנו פותחים פה איזשהו משתנה, num, או בוא ניקח h, ואנחנו רוצים לכתוב בדיוק מה המשתנה הזה.

6. 01:31

   השיטה הראשונה שכבר ראינו זה שני סלאשים. כאן אנחנו יכולים לכתוב בדיוק מה המטרה של המשתנה. דוגמא User Age. ניקח Username, The Client's Username וכו' וכו', וזאת שיטה ראשונה.

7. 01:58

   שיטה שנייה, בואו נניח שאנחנו עכשיו רוצים לומר למשתמש Enter Your Age. Age שווה convert to in32.console.readLine. ואנחנו יכולים לבצע תיעוד בצורה כזאת Getting the User Age for Printing his Age in one year from now.

8. 02:50

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

9. 03:06

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

10. 03:28

    אז זאת השיטה השנייה. דרך אגב, אם אתם רוצים לסמן קוד ולהפוך אותו להערות במקש אחד זה יהיה קונטרול קיי שימו לב שברגע שלחצתם קונטרול ומקש אתם רואים פה למטה מה ויז'ל סטודיו כותבת לנו קונטרול קיי was pressed waiting for second key of chart זאת אומרת שוויז'ל סטודיו מחכה לעוד

11. 03:51

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

12. 04:09

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

13. 04:21

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

14. 04:48

    כעת אם אנחנו מסתכלים על הפונקציה ואנחנו רוצים לקרוא לה, get max number אנחנו רואים שהיא כמובן מופיעה ברשימת ההצעות של visual studio רשימת ההצעות נקראת intelligence ואנחנו רואים את ה-get max number וכאשר אנחנו באמת מגיעים אליה אנחנו רואים פה משהו שנקרא טולטיפ והוא פשוט

15. 05:09

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