Java/הערות בסיסיות
הערות בסיסיות בנוגע לכתיבת תוכניות שיכולות לחסוך הרבה זמן ותסכול:
הפרטים הקטנים
[עריכה]חלק בלתי נפרד מכתיבת תוכניות הוא פרטים קטנים שיכולים להראות זניחים: נקודה-פסיק בסוף שורה, סוגריים, צומדיים, וכן הלאה. כל פרט כזה שנשכח יגרום לתוכנית שלא לרוץ. יותר מכך: שפת ג'אווה מבדילה בין אותיות קטנות לגדולות, כך שלמשל הביטוי Hello עבור ג'אווה שונה מ-hello. ניסיון, אימון וסביבת עבודה מסייעת יעזרו לצמצום טעויות כאלה לאפס.
|
כדאי לדעת: סביבות עבודה כמו eclipse וintellij מסוגלות לאתר טעויות אלה עוד בשלב הכתיבה על ידי סימון (בדומה לבודק איות במעבד תמלילים) ולפעמים אף להציע דרכי תיקון. |
סגנון ותיעוד
[עריכה]מספר עקרונות יסייעו לכתיבת קוד ברור, נקי וקריא:
יישור
[עריכה]יישור (אינדנטציה - Indent) משמעו שימוש בהזזת הטקסט הנכתב בכל פעם שמתחילים קטע קוד כדוגמת מחלקה, מתודה, לולאה וכיוצא בזה. לדוגמה:
מחלקה
- שיטה
- ...
- לולאה
- תוכן הלולאה
- ...
יישור השורות אינו משנה דבר עבור המהדר; למעשה, ניתן לכתוב את התוכנית כולה בשורת טקסט ארוכה אחת. עם זאת, כתיבה תוך שימוש ביישור תקל מאוד על קריאת התוכנית. כמעט כל סביבת עבודה תדע לבצע את היישור בעצמה. גם עורכי טקסט מתקדמים כמו אימקס או VIM ידעו לעשות זאת.
תיעוד
[עריכה]התוכנית שכתבנו עד כאן הייתה פשוטה מאוד. עם זאת, תוכניות עשויות לכתוב אלפי שורות קוד, מאות מחלקות, וכמות עצומה של מתודות ומשתנים. כדי להשליט סדר, נהוג לתעד את מה שנכתב.
הערות פשוטות
[עריכה]הערות פשוטות מסמנים על ידי // בתחילת ההערה. כאשר מבחין המהדר בסימן זה, הוא יתעלם מכל מה שכתוב אחריו. לדוגמה:
// This is a text
אם רוצים לכתוב הערות ארוכות יותר, אפשר להשתמש בסימן */ כדי לפתוח בלוק הערה, ו- /* כדי לסגרו. לדוגמה:
/*
גם מהערות כאלה יתעלם המהדר.
This is a text
And more
*/
Javadoc
[עריכה]Java משתמשת בשיטה משוכללת של הערות המכונה Javadoc, אך לא נרחיב כאן על אופן השימוש בה. למעוניינים, בספר ההמשך קיים פרק המוקדש ל-Javadoc. בספר הנוכחי נשתמש רק בצורת התיעוד הפשוטה שהוסברה כאן.
| הפרק הקודם: שלום עולם! |
הערות בסיסיות | הפרק הבא: משתנים |