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