תיעוד זה אחד הדברים שכולם מסכימים שהוא הכרחי ומומלץ מאוד, אך מעטים הם אלו שמבצעים אותו הלכה למעשה.
גם כשמתעדים צריך לדעת מה ואיך לתעד.
הערות מהסוג הזה
קוד:
i++; //increase the index by 1
נעות בין מיותר למבלבל.
לדעתי חשוב לכתוב הערות בקטעי קוד שלדעתך אתה או מתכנת אחר (שמכיר את המערכת) יסתכל ויתקשה להבין במה מדובר.
לדוגמא בתנאי מורכב בכל אחד מה-else if שלו אני אוהב לכתוב חצי משפט שמסביר מה נכנס לתנאי הזה.
בהגדרת משתנים גם מאוד מומלץ לכתוב הסבר קטן של מה שהמשתנה יכיל.
יש כאלה שאוהבים לקבוע שמות למשתנה, פונקציות, קלאסים, IDs וכו' עם תחילת מסיימת.
לדוגמא var iUserId על מנת לציין שמדובר ב-integer או id="btnAddNew" בכפתור שמבצע פעולה מסויימת.
בכל אופן, אם אתה לא עובד בצורה רציפה על הפרויקט הגיוני שתשכח איך חלקים ממנו עובדים או איך להשתמש בפונקציות מסויימות. אז אין ברירה וחייבים להזכר: להסתכל איך השתמש בהן במקומות אחרים או לעבור על הפונקצית ולראות מה היא עושה.
בעבודה רציפה על פרויקט בד"כ אתה נכנס לתמונה וזוכר איך להשתמש בדברים שאתה כתבת.