התלמוד של המפתחמסכת אבות המפתח
6 הלכות
פונקציה העושה יותר מדבר אחד — כשרה אינה. מצאת בשמה את מילת ה"ו" — fetchAndSave, validateAndSend — חזקה שעוברת על הכתוב, ואין לה כפרה אלא פיצול.
אמרו חכמים: שם פונקציה שיש בו ו׳ החיבור הרי הוא כשלט אזהרה. ומעשה היה במפתח אחד שכתב getUserDataAndSendEmailAndLogToDatabase — ועד היום מחפשים את הבאג.
המעתיק קוד ממקום למקום — עתיד ליתן את הדין. שנאמר: אל תחזור על עצמך, אפילו פעם אחת.
ויהי היום ותיקן המפתח באג במקום אחד, וישכח את המשוכפל — ויהי הבאג, ויהיו הדמעות, ויהי לילה ארוך.
כל המוסיף חכמה יתרה על הקוד — גורם לבכי לדורות. פשוט ועובד עדיף על גאוני ושבור.
הרואה קוד שאי אפשר להבינו בלא עשר דקות — בחזקת קוד רע הוא, ואפילו כתבו גאון. שכן אמרו: כתוב לאדם, לא למהדרין.
פשטות היא מעלה עצמאית. קוד פשוט קל לקריאה, קל לתחזוקה, וקל לבדיקה. המורכבות עצמה — היא הבאג הגדול ביותר.
פשטות מדומה היא מלכודת. לפעמים ה-algorithm ה"מסובך" הוא היחיד שרץ בזמן סביר. קוד פשוט שלוקח שעה לרוץ — אינו פשוט, הוא כשל.
ומתי ראית לאחרונה bottleneck אמיתי שלא ניתן לפתור בפשטות?
כל יום שאני כותב קוד. אין פשרות על O(n²) כשיש O(n log n).
כתוב קוד ברור קודם. מדוד. אז ובלבד — ייעל.
כתוב פשוט קודם. אם מדידה מוכיחה שזה אטי — אז תסבך. לא לפני.
x, data, temp, manager2 — אלו שמות אסורים. שם המשתנה חייב לבטא כוונה, ומי שמשתמש בהם — הרי הוא כמי שמדבר בלשון סתרים.
נשאל אחד מן החכמים: מהו d2? ויאמר: איני יודע, ואני כתבתי אותו. הוי אומר: שם רע הוא גזרה על עצמך ועל הבאים אחריך.
אסור לבנות פיצ׳ר שלא התבקש. הכותב קוד "למקרה שיהיה צורך" — כאילו בנה בית לאורח שלא יגיע.
עקרון YAGNI — You Aren't Gonna Need It. ודרשו חכמים: כל קוד שנכתב ולא נדרש — צריך לתחזק, צריך לבדוק, צריך להסביר. ולמה? לשם מה? לא ידוע.
הערות קוד הבאות לפרש את המובן מאליו — פסולות הן. כתוב קוד שמסביר את עצמו, ואם אינך יכול — זהו הסימן שהקוד עצמו בעיה.
i++ // מגדיל את i באחד — הרי זו הערה שמחרפת את הקורא. אך הערה המסבירה מדוע נעשה דבר — כשרה היא ואף מצווה. ההבדל: what אסור, why מותר ואף רצוי.
קוד טוב אינו צריך הערות. שמות ברורים ופונקציות קצרות — הם ההסבר. הערה היא הוכחה שנכשלת לכתוב קוד ברור.
הערות הן מכתב אהבה לעצמך של העתיד. מי שאינו כותב הערות — שונא את הקורא הבא, שלעיתים הוא הוא עצמו.
הערה שמתיישנת — גרועה מהיעדר הערה. שקר כתוב הוא מסוכן מדממה.
אז עדכן אותה! חוסר תחזוקה אינו נימוק לחוסר הסבר.
קוד שמסביר עצמו אינו זקוק לתחזוקה נפרדת.
שניהם צודקים בחצי. הערות what — אסורות. הערות why — מצווה גמורה.