Java/תיעוד

ניווט בנושא יסודות השפה מוסכמות קידוד תיעוד משתנים פלט וקלט מחרוזות תנאים לולאות הרחבה על משתנה בוליאני, ערך null מערכים שיטות רקורסיה מחלקות נפוצות יוניקוד

עיקר התיעוד ב־java נחלק לשני חלקים: 1. הערות בקוד 2. שימוש ב־javaDoc

הערות קוד

הערות בקוד מתבצעות באמצאות השימוש בשני לוכסנים (//) וכל הטקסט בשורה אחריו יחשב כהערה.

// שיטה שפותרת משוואה ריבועית מסוג ax^2 + bx + c = 0
public static double[] solveQuadraticEquation(double a, double b, double c) {
	double d = b * b - 4 * a * c; // ערך הדלתא שממנו, אולי, נחשב את השורש
	if(d == 0) // למשוואה יש פתרון אחד
		return new double[] { -b / (2 * a) };
	else if (d > 0) { // למשוואה יש שני פתרונות
		double r = Math.sqrt(d); // השורש של ערך הדלתא
		return new double[] { (-b - r) / (2 * a), (-b + r) / (2 * a) };
	}
	else // למשוואה אין פתרונות, כי d < 0
		return new double[] { Double.NaN }; // נחזיר את ערך ה־NaN
}

כדי ליצור הערה עם יותר משורה אחת ניתן להשתמש בסימון הבא: לפני תחילת ההערה נרשום (/*), ונסיים אותה עם (*/). בין השורות ניתן לרשום בהתחלה כוכבית עם רווח מקדים ( *), אך אין זה חובה

/*
 * (C) 2025 כל הזכויות שמורות למה־שמו ושות׳
 * אין להעתיק, לשכפל, לצלם, לתרגם, לאחסן במאגר מידע, לשדר או לקלוט
 * בכל דרך או בכל אמצעי אלקטרוני, מכני, מגנטי, אופטי או אחר
 * כל חלק שהוא מהקוד הזה, ללא קבלת אישור מפורש לכך ע״י למה־שמו ושות׳
 * בכל בעיה או בקשה ניתן לפנות בדוא״ל: mashmo@gmail.com
 */

דבר זה שימושי במיוחד, אם רוצים להשבית קטע קוד שאיננו מעוניינים בריצתו או קִמפוּלו, או בקבלת הודעות שגיאה בגללו.

/*
public Complex add(Complex c) {

}
*/

JavaDoc

JavaDoc נכתב בדומה להערה מרובת שורות אך עם עוד כוכבית בהתחלה:

/**
 *
 *
 *
 */

ההבדל בין javaDoc להערה מרובת שורות הוא שכאשר משתמשים בIDE, רובן יאפשרו לך לראות את ה־javaDoc כאשר מניחים את הסמן על שיטה מסוימת.