You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3.3 KiB
3.3 KiB
הוסף הערות לקוד שלך
הוראות
קוד נקי ומתועד היטב הוא חיוני לשמירה ושיתוף של הפרויקטים שלך. במשימה זו, תתרגלו אחד ההרגלים החשובים ביותר של מפתחים מקצועיים: כתיבת הערות ברורות ומועילות שמסבירות את מטרת הקוד והפונקציונליות שלו.
עברו על קובץ app.js הנוכחי בתיקיית המשחק שלכם, ומצאו דרכים להוסיף הערות ולסדר אותו. קל מאוד שהקוד יצא משליטה, ועכשיו זו הזדמנות טובה להוסיף הערות כדי להבטיח שיהיה לכם קוד קריא שתוכלו להשתמש בו מאוחר יותר.
המשימה שלכם כוללת:
- הוספת הערות שמסבירות מה כל חלק מרכזי בקוד עושה
- תיעוד פונקציות עם תיאורים ברורים של מטרתן והפרמטרים שלהן
- ארגון הקוד לבלוקים לוגיים עם כותרות של חלקים
- הסרת קוד שאינו בשימוש או מיותר
- שימוש עקבי בשמות משתנים ופונקציות
קריטריונים להערכה
| קריטריון | מצטיין | מספק | דורש שיפור |
|---|---|---|---|
| תיעוד קוד | קובץ app.js מתועד במלואו עם הסברים ברורים ומועילים לכל החלקים המרכזיים והפונקציות |
קובץ app.js מתועד בצורה מספקת עם הסברים בסיסיים לרוב החלקים |
קובץ app.js מכיל מעט הערות וחסרים בו הסברים ברורים |
| ארגון קוד | הקוד מאורגן לבלוקים לוגיים עם כותרות ברורות ומבנה עקבי | הקוד מאורגן חלקית עם קיבוץ בסיסי של פונקציונליות קשורה | הקוד מעט מבולגן וקשה לעקוב אחריו |
| איכות קוד | כל המשתנים והפונקציות משתמשים בשמות תיאוריים, אין קוד שאינו בשימוש, עוקב אחרי מוסכמות עקביות | רוב הקוד עוקב אחרי שיטות טובות לשמות עם מעט קוד שאינו בשימוש | שמות המשתנים אינם ברורים, מכיל קוד שאינו בשימוש, סגנון לא עקבי |
הצהרת אחריות:
מסמך זה תורגם באמצעות שירות תרגום AI Co-op Translator. למרות שאנו שואפים לדיוק, יש לקחת בחשבון שתרגומים אוטומטיים עשויים להכיל שגיאות או אי דיוקים. המסמך המקורי בשפתו המקורית צריך להיחשב כמקור סמכותי. עבור מידע קריטי, מומלץ להשתמש בתרגום מקצועי אנושי. איננו אחראים לאי הבנות או פירושים שגויים הנובעים משימוש בתרגום זה.