Clean Code

אני זוכרת את הפעם הראשונה שכתבתי פונקציה מורכבת במיוחד. הייתי כל כך מרוצה מעצמי, אבל כשחזרתי אליה אחרי חודש, לא הצלחתי להבין מה כתבתי… מאז למדתי שבקוד, כמו בכל דבר בחיים, סדר והיגיון הם הכל. אני אוהבת לשים דגש על שמות פונקציות ומשתנים ברורים, ולחלק את הקוד למקטעים קטנים. זה אמנם לוקח עוד כמה דקות בזמן הכתיבה, אבל חוסך המון זמן אחר כך – לי ולעמיתים שלי.אז מה זה קוד? ומה זה קוד נקי?
קוד הוא שפת המחשב אותה אנחנו "מדברים". קוד נקי הוא קוד קריא וברור, כזה שמאפשר לנו להבין בקלות (עכשיו ו)בעתיד מה הוא עושה ולמה. המטרה: לחסוך זמן, למנוע טעויות ולשפר את חווית העבודה.
למה קוד נקי חשוב?
כשקוד לא ברור או לא מסודר, הוא עלול לגרום לבעיות רבות:

• באגים ורגרסיות: מתכנת עלול לשנות חלקים בקוד מבלי להבין אותם לעומק, ולגרום לבעיות בחלקים שכבר עבדו כראוי.
• בזבוז זמן: להבין קוד מבולגן לוקח זמן רב – לפעמים יותר זמן מאשר לכתוב אותו מחדש.
• אי-נוחות אישית: גם אם זה הקוד שלך, ייתכן שבעוד חודש כבר לא תזכור למה כתבת אותו כך.

נדמה את זה לעבודה במטבח?
אם כל כלי ותבלין במקום, נוכל לבשל במינימום בלבול ובלי טעויות. לעומת זאת, מטבח מבולגן - טעות קטנה כמו להחליף מלח בסוכר, עלולה להרוס את הכל... בקיצור - סדר וארגון הם סוג של מפתח לחיסכון זמן, מניעת טעויות ועוד

אז איך כותבים קוד נקי?
הנה כמה כללים פשוטים שיעזרו לך לשמור על קוד קריא וברור יותר:

• שמות ברורים: השתמשו בשמות שמתארים בדיוק את תפקיד המשתנה או הפונקציה, גם אם הם ארוכים.
• חלוקה למקטעים: חלקו את הקוד לפונקציות ורכיבים קטנים, שכל אחד עוסק במשימה אחת בלבד.
• החזרת ערכים: שמרו על מעקב ברור אחרי מה הפונקציה מחזירה. עדיף להקצות את התוצאה למשתנה ורק בסיום להחזיר אותה.
• הוספת הערות: במקרים מיוחדים, הוסיפו הערות שמסבירות את ההיגיון או ההנחיות מאחורי הקוד.
• חשיבה על הקוראים: זכרו – מישהו אחר, או אתם בעתיד, יצטרכו להבין את הקוד הזה.

אז אם את/ה מתחיל/ה לכתוב קוד – תכתבו אותו כאילו אתם מסבירים אותו לעצמכם. לא רק בשביל מי שיקרא אותו אחר כך, אלא גם בשביל עצמכם….