שמות נכונים למשתנים

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

לדוגמא, מתכנתים רבים אוהבים לקצר שמות ולאגד אותם בראשי תיבות שלעיתים מרמזים לאנשים שונים משמעות שונה.
למשל

String awk;

Strung ls

בפלטפורמות unix למינהם השמות הללו מבטאים שפת סקריפטים ורשימת קבצים, בהתאמה.
אפילו אם נראה ש awk זה קיצור טוב ל-acknowledge ו-ls אולי נשמע כמו קיצור טוב ל-lowSpecs המנעו מכך, זה יכול להוליך שולל.

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

למשל, מקרה מאוד נפוץ הוא עם list. אנשים רבים משתמשים בשם המשתנה עם סיומת LIST.
מומלץ להמנע מכך.
לדוגמא, יש לך רשימת חברים. FriendsList אבל בעתיד אולי זאת לא תיהיה רשימה, אתה תחטא לאמת ולכוונה המקורית של המשורר שפשוט התכוון לחברים, Friends

כעת אתם יודעים קצת על שמות אבל לפעמים אתם גם רוצים לדבר עליהם עם הצוות,
להעביר רעיונות ואולי אפילו לקבל ביקורת בונה, אתם צריכים לתת שמות שניתן לבטא.
למשל שם כמו:  imgEnc הוא שם פחות טוב מ-ImageEncoder.
רק משום קל יותר לבטא אותו.

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