כשרוצים להתקבל ל-8200, כל שורת קוד היא ממש כרטיס ביקור. המבחנים והפרויקטים האישיים לא נמדדים רק לפי התוצאה, אלא לפי הדרך. קוד מבולגן עשוי להעיד על בלבול, חוסר סדר או חוסר הקפדה – גם אם הרעיון היה מצוין. בכתבה הזו תמצאו 5 טיפים שיעזרו לכם לכתוב קוד שנעים לקרוא, ברור להבין – וכזה שיגרום למי שבודק אותו לעצור ולהתעניין.
1. שמות משתנים ופונקציות – אל תמעיטו בערכם
לקוד שלכם יש שפה פנימית. אם תקראו למשתנה x, תצטרכו כל פעם להזכיר לעצמכם מה הוא עושה. לעומת זאת, משתנה בשם userScore או isAdmin לא דורש הסבר.
כמה כללים קטנים שיעשו הבדל גדול:
- בחרו שמות שמתארים את תפקיד המשתנה
- אל תשתמשו בקיצורים לא מובנים
- לפונקציות – תנו שם שפועל ומבהיר מה הפעולה עושה
- הימנעו מ"copy-paste" של שמות עם שינוי קל – זה מבלבל
2. שמרו על מבנה עקבי – העין יודעת לזהות סדר
קוד מסודר עוזר להבין את מה שכתוב מהר יותר. הקפידו על:
- רווחים לפני ואחרי סימנים כמו =, +, :
- הזחות ברורות – במיוחד בלולאות ובתנאים
- שורות ריקות בין בלוקים של קוד
- מבנה קבוע – אם התחלתם עם פייתון בסגנון מסוים, תמשיכו איתו
אם זה מרגיש כמו עמוד בספר לימוד – אתם בכיוון הנכון.
3. טעויות שכדאי להימנע מהן
כמה דברים קטנים שיכולים לקלקל רושם ראשוני: קוד דחוס מדי בלי רווחים, שמות משתנים לא ברורים כמו a1 או doStuff, וחזרה על אותו קוד במקום לכתוב פונקציה. לפעמים דווקא הדברים האלה גורמים לבדיקה להיראות פחות רצינית – גם אם הרעיון מצוין. שמרו על פשטות, בהירות והיגיון.
4. פרקו את הקוד לחלקים
אחד העקרונות שחוזרים על עצמם בכל קורסים והדרכות ליחידה 8200 הוא: לפרק בעיות לחלקים קטנים. אותו עיקרון תקף גם לכתיבת קוד
- אל תחששו מהוספת פונקציות – גם לפעולה שנראית קטנה
- אם קשה להסביר במילים מה פונקציה עושה – כנראה היא מורכבת מדי
- חפשו מקומות שבהם הקוד חוזר על עצמו – ושימו אותם בתוך פונקציה
5. תיעוד, הערות והתחשבות באחרים
לא כולם יושבים בראש שלכם. הבודק, או מי שיסתכל על הקוד אחריכם, לא יודע למה החלטתם להוסיף את תנאי if הזה דווקא שם. הערות קצרות – לא מגילות – עוזרות להבין את מה שלא נראה לעין.
- בתחילת כל קובץ – הסבר מה הוא עושה
- לפני כל פונקציה – תיאור קצר (שורה אחת מספיקה)
- הערות בתוך הקוד – רק כשיש משהו שאינו מובן מאליו
- תעדו בעקביות, כדי לייצר הרגל
לסיכום
כתיבה נקייה היא לא פריבילגיה – היא חלק מהדרך להבין טוב יותר את עצמכם ואת החשיבה שלכם. כל טיפ קטן שתיישמו הוא צעד בדרך לשיפור. כשאתם כותבים קוד, תחשבו על מי שיקרא אותו – ואולי, מתישהו, גם תמצאו את עצמכם שם, בצד שבודק אותו.
