Java/תיעוד
< Java
קפיצה לניווט
קפיצה לחיפוש
ניווט בנושא יסודות השפה
|
עיקר התיעוד בjava נחלק לשני חלקים: -הערות בקוד -שימוש בjavaDoc
הערות בקוד מתבצעות באמצאות השימוש ב// ולאחר מכן כל הטקסט בשורה יחשב כהערה, כדי ליצור הערה עם יותר משורה אחת ניתן להשתמש ב:
- /
/*
כאשר בכל תחילת שורה חדשה נדרש להוסיף כוכבית
javaDoc: javaDoc נכתב בדומה להערה מרובת שורות אך עם עוד כוכבית בהתחלה:
- /
/*
ההבדל בין javaDoc להערה מרובת שורות הוא שכאשר משתמשים בIDE, רובן יאפשרו לך לראות את הjavaDoc כאשר אתה מניח את הסמן על הmethod