את המאמר הזה קיבלתי מרון ועל אף שקראתי לא מעט מאמרים בנושאי כתיבת קוד, עדיין מצאתי שיש במאמר זה דברים חשובים.המחבר מתחיל בכך שהוא טוען שזמנו של מתכנת הוא יקר מאד, והטיפים שלפנינו יסייעו לחסוך בזמנו של המתכנת.
- לתעד בחוכמה – כאן הוא מתחיל בדברים ידועים: יש לכתוב בהערות מדוע נכתב הקוד, ולא מה עושה הקוד (את זה אפשר לראות בקוד עצמו). אח”כ הוא נותן כללים ברורים לכל קטע קוד:
- מספר משפטים לפני מתודה, המסבירים מה היא עושה
- תאור הערכים המועברים אליה
- אם המתודה מחזירה ערך, יש להסביר גם אותו
הערה: עד כאן, ה-Visul Studio מסייע מאד ליישום כללים אלה. - בתוך המתודה, הערות המחלקות את המתודה למשימות קצרות יותר [הערה שלי: יש מקרים שבהם עדיף להוציא חלקים כאלה למתודה אחרת]
- עבור קטעי קוד בעייתיים, הסבר קצר מה-קורה-פה.
- להשתמש ב-const – משתנים שיש להם ערך קבוע לכל אורך הקוד, עדיף להגדירם בהתחלה כמשתנים קבועים (const). לדבריו, רוב המתכנתים יודעים זאת, אך יש צורך במידה רבה של משמעת עצמית כדי ליישם זאת.
- להשתמש בשמות משתנים בחוכמה -המטרה הכללית היא פשוטה: לכתוב קוד כך שאם אדם שאין לו מושג במה מדובר קורא אותו, הוא יוכל להבין מה קורה במהירות האפשרית.
- לכתוב בדיקות בקוד – כאשר כותבים מתודה/פונקציה, עלינו תמיד לחשוב: “נניח שאדם מרושע או מטורף יעביר לנו כל מיני ערכים מוזרים ומזעזעים. כיצד יגן קטע הקוד העדין והמסכן הזה על עצמו וימנע מהמחשב להתפוצץ?”
- “אופטימיזציה טרם זמנה היא שורש כל רע” – דונלד קנות’ – המטרה הראשונה בכתיבת קוד היא בהירות. אופטימיזציה היא אוייבת הבהירות. לפעמים אין ברירה וחייבים לבצע אופטימיזציה, אבל הדרך היחידה לדעת איפה לבצע אותה היא ע”י בדיקות על הקוד, והרצה של הקוד ב-profiler. לכן, דבר ראשון, יש לכתוב משהו נקי שרץ. יהיה מספיק זמן אח”כ לכער את זה באופטימיזציה…
- לא להתחכם יותר מדי – דחיפת כמה פקודות בשורה אחת אולי מראה שליטה בשפה, אבל המחיר הוא אי-יכולת לתקן במהירות באג שהצלחנו להכניס בשורה הזו….