Java/מוסכמות קידוד

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


יסודות_השפה Java
מוסכמות קידוד
תיעוד
ניווט בנושא יסודות השפה


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

משתנים[עריכה]

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

  1. מעיד על התפקיד שלו (הערך אותו הוא זוכר)
  2. קצר
  3. קריא וברור

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

מעיד על תפקיד המשתנה[עריכה]

למשל, בתכנית הקולטת את מספר ימיי העבודה של עובד, ומדפיסה את מספר ימיי החופשה שהוא זכאי להם, לא נוכל לקרוא למשתנה הזוכר את ימיי החופשה days, משום שאז נתבלבל עם זה הזוכר את מספר ימיי העבודה. במקום זה, נוכל לקרוא לימיי החופשה VacationDays, ולימיי העבודה WorkDays. זה יקל על מי שקורא את התכנית, שיכול להבין במבט ראשון מה כל משתנה זוכר ומה תפקידו. כך ננהג לגבי כל משתנה. למשתנה שבודק כמה פעמים התמלא תנאי נוכל לקרוא count, למשתנה צובר נקרא sum ולאחד שזוכר מספר ילדים נקרא kids. אפשר גם לקרוא למשתנים שוליים או כאלה שמשמשים כמונים בלולאות פשוט באות הראשונה של הטיפוס שלהם. למשל: char c='a';.

קצר[עריכה]

נניח שאנו יוצרים משתנה המכיל את מספר ימיי החופשה של מועסקים גברים והתכנית מחשבת את מספר הימים האלה לפי נתונים כלשהם (כמו חופשת הלידה המגיעה לאבות ומספר הימים שעבדו). הדרך הכי קריאה וברורה לקרוא למשתנה הזה, כמו גם השם שיעיד הכי טוב על תפקידו יהיה int VacationDaysOfMaleEmployees;, אך זה שם מסורבל וארוך, ויהיה מתיש לקרוא ולכתוב אותו בהמשך התכנית. יהיה קל יותר גם לטעות בכתיבת השם, ואז המהדר לא ידע לגשת אליו. במקום זאת, נוכל לקרוא למשתנה int vacDayMaleEmp, או בשם אפילו קצר יותר, אם נסביר לידו את התפקיד שלו: int vdme; //Vacation days of male employee.

מוסכמות נוספות[עריכה]
  1. שמות של אובייקטים (ראה בהמשך) נהוג שמתחילים באות גדולה.
  2. משתנים מתחילים באות קטנה. כאשר נותנים שם למשתנה שמכיל יותר ממילה אחת כל מילה אחרי הראשונה מתחילה באות גדולה.


יסודות_השפה Java
מוסכמות קידוד
תיעוד