כיצד לכתוב הערה בשפת תכנות מחשבים?

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

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

צעדים

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

טיפים

  • הערות טובות מסבירות מה מתכנת קיווה לעשות כשכתבו את התוכנית.

אזהרות

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

שאלות ותשובות

  • איזו שפת תכנות היא הכי קלה למתחילים?
    אין באמת שפה קלה ביותר, מכיוון שלכולם יש כמה דברים קלים וקשים. עם זאת, חלקם דורשים ממך ללמוד מושגים מתקדמים יותר לפני שתתחיל. התחלתי לתכנת עם פייתון וחושב שפייתון די ידידותי למתחילים. אתה יכול גם להתחיל במשהו שאינו ממש שפת תכנות, אך מציג את המושגים, כמו Scratch, לאן גוררים בלוקים סביב לתכנות.
  • כיצד אוכל לכתוב תכנות עם הערות?
    שפות שונות משתמשות באינדיקטורים שונים של הערות. Python, למשל, משתמש ב- #, בעוד C משתמש ב- / /.

FacebookTwitterInstagramPinterestLinkedInGoogle+YoutubeRedditDribbbleBehanceGithubCodePenWhatsappEmail