[3 באוגוסט 2010] [8 תגובות]

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

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

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

כשמתחילים לכתוב פתרון כזה, בדרך כלל מתקבלת תוצאה שדומה לקוד הבא:

if (someObject != null)
{
        if (checkSomething() >= 5)
        {
                if (checkSomethingElse() >= 5)
                {
                        if (initFunction() == RESULT_OK)
                        {
                                if (doSomething() == RESULT_OK)
                                {
                                        printf("Success!");
                                }
                                else
                                {
                                        printf("failed to do");
                                }
                        }
                        else
                        {
                                printf("failed to init");
                        }
                }
                else
                {
                        printf("also less than 5");
                }
        else
        {
                printf("less than 5");
        }
}
else
{
        printf("null pointer");
}

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

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

הנה קוד שנראה מעט טוב יותר:

do
{
        if (someObject == null)
        {
                printf("null pointer");
                break;
        }

        if (checkSomething() < 5)
        {
                printf("less than 5");
                break;
        }

        if (checkSomethingElse() < 5)
        {
                printf("also less than 5");
                break;
        }

        if (initFunction() != RESULT_OK)
        {
                printf("failed to init");
                break;
        }

        if (doSomething() != RESULT_OK)
        {
                printf("failed to do");
                break;
        }

       printf("Success!");

} while (0)

בצורה זאת ניתן להוסיף המון פעולות ברצף והקוד ממשיך להיות מסודר.

פתרון אחר (ודומה) הוא לכתוב פונקציה שמבצעת את הבדיקות האלו, כאשר בתוך הפונקציה אין צורך בלולאה, וניתן לסיים על ידי return במקום על ידי break.

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

אני אוסף כל מיני טיפים קטנים. אני מקווה לפרסם אותם כאן בקרוב.