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, כתיאור תמציתי לכל פריט
ופריט.
מאגר מידע בנושאי מחשבים ומדעים מדויקים
xss hack
אני רוצה שתעזור לי ב xss אשמח לתשובה