כיצד להשתמש בתגובות בקוד Java

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

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

סוג אחר של הערת ג'אווה הוא הערת Javadoc. הערות Javadoc שונות בתחביר מעט מתגובות היישום ומשמשות את התוכנית javadoc.exe לייצור תיעוד HTML ב- Java.

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

הערות יישום ב- קוד Java הם רק שם שבני אדם יכולים לקרוא. למהדרים של ג'אווה לא אכפת מהם ומתי קומפילציה של התוכנית, הם פשוט מדלגים עליהם. הגודל והיעילות של התוכנית הידור שלך לא יושפעו מכמות התגובות בקוד המקור שלך.

הערות יישום מגיעות בשני פורמטים שונים:

• הערות שורה: לקבלת הערה בשורה אחת, הקלד "//" ובצע את שתי הקצוות קדימה עם התגובה שלך. לדוגמה:

   // זו הערת שורה אחת
  int guessNumber = (int) (Math.random () * 10); 

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

  •  // זו הערת שורה אחת
    // int guessNumber = (int) (Math.random () * 10); 

    אתה יכול גם להשתמש בשני הצלפים הקדימים כדי להגיב לסיום הערת השורה:

  •  // זו הערת שורה אחת
    int guessNumber = (int) (Math.random () * 10); // הערת סוף 

• חסום תגובות: כדי להתחיל תגובה לחסום, הקלד "/ *". כל מה שקורה בקו האחורי לכוכבית, גם אם זה בקו אחר, מטופל כהערה עד שהדמויות "* /" מסיימות את ההערה. לדוגמה:

   / * זה 
  הוא 
  א
  חסום
  תגובה
  */
  / * כך זה * /
  

השתמש בתגובות Javadoc מיוחדות כדי לתעד את ה- API שלך ל- Java. Javadoc הוא כלי הכלול ב- JDK המייצר תיעוד HTML מתגובות בקוד המקור.

תגובה Javadoc ב

.ג'אווה

/**

*/

*

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

// myClass.java
/**
* הכינו זה משפט סיכום המתאר את הכיתה שלכם.
להלן שורה נוספת.
*/
ציבורימעמד הכיתה שלי
{
...
}

Javadoc משלב תגיות שונות השולטות ביצירת התיעוד. לדוגמה,

@ פארם

 / ** השיטה העיקרית
* @param טוען מחרוזת []
*/​
ציבוריסטטיבטל עיקרי (מחרוזת [] טענות)
​{
System.out.println ("שלום עולם!");
}

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

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

   / * זה 
  הוא
  / * הערת החסימה הזו מסיימת את ההערה הראשונה * /
  א
  חסום
  תגובה
  */