4.2. תחביר

צורתה הכללית של הערת Javadoc היא **/ בהתחלה ו- /* בסוף.

כל הערת Javadoc נחלקת לשניים: בתחילתה מופיע טקסט ובהמשך נכתבות תגיות ה-Javadoc.

בגרסאות ישנות של Javadoc נדרש גם שבין שני החלקים (הטקסט המתאר והתגיות) תופיע שורה ריקה שבתחילתה *.

דוגמא:

/**

 * This is the descriptive text of the doc comment.

 *

 * @Xxx     Comment for the tag.

 * @Yyy     Comment for the tag.

*/

public class Aaa

{

}   

הערת ה-javadoc חייבת להופיע בצמידות מעל הגדרתה של מתודה/משתנה/מחלקה וכו'... וללא כל שורת ריווח ביניהם.



גם בשורת ההתחלה וגם בשורת הסיום, מלבד סימני ההתחלה: /**   ו-  */ לא יופיע דבר.

כל שורה נוספת אשר תופיע בהערת ה-javadoc  תתחיל בסימן *.

ניתן להשתמש בהערות בתגי HTML בתוך ההערות. תגי ה-HTML יועברו כמו שהם אל קובץ הפלט.

בד"כ נשתמש למשל בתגית <P> כדי לעבור לפיסקה חדשה או בתגיות <LI></LI> כדי ליצור רשימה של אלמנטים.

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

תגיות המסמך:

מאת: נועה

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

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

054-8818353 אמילי

055-9310377 יעל
מאת: anonymos

xss hack

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

תודה רבה!

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

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

עזרה

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

תיכנות

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

תחביר

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