מה הבעיה בקטע הבא:
// employee number i gets (employee number i) + salary
employees[i] = employees[i] + salary
- אין בעיה - סבבה של תיעוד
- שורת ההערה יותר ארוכה מהקוד עצמו!
- השורה לא תורמת כלום - סתם חוזרת מילה במילה על מה שהקוד עושה
- השורה לא מפורטת מספיק. צריך להסביר איפה בונים את המערך, מקצים אותו ומשחררים אותו
מה הבעיה בקטע הבא:
int ic; // Icon to put on the form
- שם המשתנה לא מסביר מה ייעודו
- התיעוד מצומצם מידי
- התיעוד מיותר - לא מוסיף מידע
- שם המשתנה צריך להתחיל באות גדולה