Notice: Undefined index: premium-vscroll in /home/codespir/domains/codespire.co.il/public_html/wp-content/plugins/premium-addons-for-elementor/includes/class-addons-integration.php on line 140

תיעוד הקוד שלך

לאחרונה אני עובד על פרויקט דיי מגניב שקשור להתממשקות למערכת קופות עצמאית. הכוונה למערכת שאיננה מערכת שמשווקת לקהל הרכב אלא עצמאית, עבור עסק ספציפי, למטרות ספציפיות בלבד. מערת custom made.

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

למשל במסמך ה-api נאמר לי שאם אני שולח תאריך + שעה ספציפית (בקפיצות של חצאי שעות) אקבל את הזמן הפנוי שיש בשעה הזאת. הבעיה הייתה שאני שולח את הפרמטרים, אבל מקבל חזרה רק אם השעה פנויה או לא, לא כמה פנוי בתוכה. וזו בעיה, א׳ כי לא ידעתי שזה מה שיחזור ו-ב׳ כי זה לא ממש עוזר לי לדעת שהשעה פנויה מבלי לדעת כמה זמן פנוי יש בה.

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

כשמערכת לא מתועדת קשה מאוד לסגור את כל הקצוות וכל אפשרויות השגיאה שיחזרו. יש הבדל אם תחזור שגיאה או יחזור לי 0 למשל.

כשאתם בונים מערכת או אפילו אתר אינטרנט רציני, תשאירו תיעוד לפונקציות שלכם, בעיקר מה הן עושות ומה הן מחזירות. זה מאוד קל ב-php storm (איתו אני עובד) או ב-ide אחרים. זה עוזר לסדר בראש הכל ולהבין כל דבר על מה הוא אחראי.

כמו שאתם מצפים להיכנס לפרויקט ולקבל מושג מהיר מה קורה בו, תשאירו אחריכם את הקרקע לבאים אחריכם.

כתיבת תגובה

האימייל לא יוצג באתר. שדות החובה מסומנים *