4.3. הערות אותן Javadoc משלב באופן עצמאי

קיימים מצבים שבהם ה-Javadoc משלב הערות באופן עצמאי. הכרת מקרים אלה יכולה לחסוך בקידוד מיותר:

  • כאשר במחלקה או ממשק שמגדירים, שיטה דורסת שיטה אחרת שמגיעה בהורשה ממחלקה אחרת או ממשק אחר אז ה-Javadoc ישלב בהערות שהוא ייצר עבור השיטה הדורסת את המשפט: “Overrides” עם קישור לתיעוד של השיטה שנדרסה (במחלקה או הממשק המוריש).

  • כאשר במחלקה שמגדירים, שיטה דורסת שיטה אחרת שמגיעה מ-interface אשר מיושם אז

    ה-Javadoc ישלב בהערות שהוא ייצר עבור השיטה הדורסת את המשפט: “Specified by” עם קישור לשיטה (כפי שהוגדרה ב-interface).

  • בכל אחד מהמקרים הנ"ל, אם השיטה אשר הוגדרה לא לוותה בהערות עבור ה-Javadoc אז

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


כאשר משלבים בתוך הערת ה-javadoc שמות (של מחלקות,packages, interfaces, מתודות, משתנים, ארגומנטים ודוגמאות של קוד) או מלים שמורות אז יש לסמנם באמצעות התגיות <code> ו-</code>

לדוגמא:

/**

 * This class is an improved version of the <code>Button</code> class.

 *

 * . . .

 *

 */

ניתן לשלב בתוך הערת Javadoc קישור למסמך אחר אשר מתאר מחלקה אחרת באמצעות @link. יש להימנע מקישור (באמצעות @link) של כל אחד משמות המחלקות אשר מופיעים בהערות ה-Javadoc אל המסמך המתאר את אותה מחלקה.

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

/**

 * Requests that this applet be resized.

 *

 *  @param   width    The new requested width for the applet

*/



תגיות המסמך:

מאת: נועה

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

היי אנחנו חרמניות ועושות שיחות לוהטות בוואטספ ומוכרות סרטונים שלנו! שלח לנו הודעה בייבי:

054-8818353 אמילי

055-9310377 יעל
מאת: anonymos

xss hack

אני רוצה שתעזור לי ב xss אשמח לתשובה
מאת: BLT

תודה רבה!

וואי הצלת אותי! קיבלתי שאלה שלא הצלחתי להבין מה רוצים ממני בכלל ועזרת מאוד, תודה :)
מאת: דולב

מה זה פונקציה?
מאת: משה

עזרה

חיה רצית עזרה ואשמח לעזור
mmh15@windowslive.com
מאת: חיה

תיכנות

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

תחביר

למרות שג'אווה מאפשרת סגנון הכרזה על מערך דומה לזה שבC++, הסגנון המומלץ באופן רשמי שונה - הסוגריים המרובעים באים מיד לאחר הטיפוס ובסמוך אליו, לא בסמוך לשם המערך.
שיתוף:
| עוד