הסבר הטכניקות שלך
המוצר חייב לפעול, אך הכתיבה צריכה להראות גם איך הוא פועל ומדוע בחרת בכל טכניקה. עבור כל טכניקה חשובה:
- קרא לה שם;
- הצג תוכן קצר ורלוונטי מהקוד שלך;
- הסבר מה היא עושה במוצר זה;
- אמר מדוע בחרת בה על פני חלופה.
דוגמה מופעלת. סידור זוגות מסדר את השחקנים לפי דירוגם, ומצמד שכנים, כך שהמרווחים בדירוג נשארים קטנים:
def make_pairings(players):
"""Pair (name, rating) tuples; return the pairs and the bye."""
ranked = sorted(players, key=lambda p: p[1], reverse=True)
bye = None
if len(ranked) % 2 == 1:
bye = ranked.pop() # lowest rating sits out
pairs = []
for i in range(0, len(ranked), 2):
pairs.append((ranked[i][0], ranked[i + 1][0]))
return pairs, bye
הסבר. סידור לפי דירוג מניח שחקנים בעלי כוח דומה זה ליד זה, ולכן צימוד שכנים נותן את המרווחים הקטנים ביותר בדירוג; הדבר עומד בקריטריון ההגינות. עם מספר אי-זוגי של שחקנים, השחקן עם הדירוג הנמוך מקבל פסיחה, וזה נבדק על ידי מבחן 4. ציוד אקראי היה פשוט יותר, אך יכל להתאים את השחקן החזק ביותר למתחיל.
רשימה של כל תכונת פייתון שבישת היא אינה הסבר. בחר בטכניקות שחשובות, כמו סידור, חיפוש, קובץ או מסד נתונים, אימות, מחלקה, והסבר אותן היטב.
שימוש בעבודת אנשים אחרים
אם השתמשת בספרייה, בדוגמת קוד מאתר או בכלי בינה מלאכותית, ציין מה המקור ומה שיניתי. זה חלק מהאינטגריטת האקדמית: עבודה שאינה שלך חייבת להיות מוזכרת. ההסבר שלך על אופן פעולת הקוד מראה שהבנת אותו.