שפת התכנות של מחשב Microsoft Visual Basic הייתה פופולרית בחוגי תכנות במשך שנים רבות. מתכנתים משתמשים בו לכל מיני פרויקטים. גרסאות של שפת תכנות זו משמשות לדפי אינטרנט, וסוגים אחרים של תוכניות Visual Basic משמשים להרבה מיישומי Windows בהם אנו משתמשים מדי יום. אחד המרכיבים המהותיים של Visual Basic הוא היכולת לכלול הערות, שהן הערות המוטמעות בקוד שאין להן תכלית קוד פונקציונלית. Visual Basic משתמש בפרוטוקול ספציפי כדי להבחין בין קוד. הוספת הערות חשובה ביותר ברוב הפרויקטים כדי לסייע לצופי קוד אנושי לקרוא נכון את מודולי הקוד. אם אתה צריך להוסיף הערות ל- Visual Basic, להלן כמה מהשלבים הבסיסיים לוודא שאתה עושה זאת נכון.
צעדים
שלב 1. קבע איזה סוג תגובה אתה רוצה להוסיף
למתכנתים מספר מטרות עיקריות שונות להערות הקובעות את הפורמט והסגנון המדויק של כלול ההערה.
- שקול הערות מודול קוד. הערות מודול הן הערות ברמה גבוהה יותר המתארות בדרך כלל את המטרות הכוללות של מודול הקוד, כמו גם מידע אחר כמו זכויות יוצרים, מחברויות ועוד.
- להעריך את הצורך בהערות נוהל. יש להעיר גם על נהלי קוד פונקציונליים שונים. הערות הנוהל מתייחסות לפונקציות הספציפיות של הקוד, והן עוזרות להתריע למתכנתים אחרים על התוצאות המדויקות של הליך בהתאם לכתיבתו.
שלב 2. בחר קטגוריות שימוש מפורטות להערות הקוד שלך
סוגים מסוימים של הערות, כמו הערות נוהל, מגיעים גם בצורות שונות. הבן את השימושים השונים האלה על מנת להוסיף את סוג ההערות הנכון לתוכנית שלך.
- להעריך את השימוש בהערות מטרה להליכים. אלה מתארים מה עושה ההליך.
- שקול את השימוש בהערות ערך החזרת פונקציות. אלה יעזרו לאחרים להבין אילו ערכים מוחזרים בהליך.
- כלול הערות מותנות. הערות מותנות יכולות לתאר תנאי שגיאה אפשריים וטיפול בשגיאות, כמו גם תנאים שיש לעמוד בהם כדי שהקוד יפעל כהלכה.
שלב 3. בחר פורמט להערות
ישנה גם השאלה כיצד תוסיף הערות לשורות קוד ספציפיות.
- השתמש בהערות שמאליות. הערות אלו מתחילות משמאל למסך וממשיכות לאורך כל קו. בדרך כלל, המקודד צריך לסיים את ההערה באופן שרירותי ליד הצד הימני של המסך, לרדת לשורה חדשה ולהמשיך את ההערה.
- השתמש בהערות בתוך השורה. הערות בשורה מכילות אפוסטרוף ישירות אחרי פיסת קוד והן ממוקמות על אותה שורה.
שלב 4. השתמש באפוסטרוף כדי לסמן את תחילת ההערות שלך
זהו שלב המפתח לכתיבת הערות לקוד בפועל. האפוסטרוף הוא פרוטוקול הטקסט הספציפי שמהדר Visual Basic מזהה להערות. בלי זה, המחשב ינסה לקרוא את ההערות כקוד.
