ב-Java הערות הן הצהרות שאינן ניתנות להפעלה המסבירות קוד ומשפרות את הקריאה. המהדר מתעלם מהם ואינם משפיעים על הפעלת התוכנית.
- שפר את קריאת הקוד ותחזוקה.
- שימושי עבור איתור באגים ותיעוד היגיון.
Java תומכת בשלושה סוגים עיקריים של הערות:
1. הערות בשורה אחת
הערות בשורה אחת משמשות להערה על שורת קוד אחת.
תַחבִּיר:
Java// הערות כאן (טקסט בשורה זו בלבד נחשב כהערה)
// Java program to show single line comments class GFG { public static void main(String args[]) { // Single line comment here System.out.println('Single Line Comment Above'); } }
תְפוּקָה
Single Line Comment Above
2. הערות רב-קו
הערות מרובות שורות משמשות לתיאור קוד או שיטות מורכבות שכן כתיבת הערות מרובות בשורה אחת עלולה להיות מייגעת.
Java/*
ההערה מתחילה
ממשיך
ממשיך...
ההערה מסתיימת
*/
class GFG { public static void main(String args[]) { System.out.println('Multi Line Comments Below'); /* Comment line 1 Comment line 2 Comment line 3 */ } }
תְפוּקָה
Multi Line Comments Below
3. הערות תיעוד
הערות תיעוד משמשות ליצירת תיעוד חיצוני באמצעות Javadoc. הם משמשים בדרך כלל בפרויקטים מקצועיים לתיאור שיטות ופרמטרים של כיתות.
תַחבִּיר:
Java/**
* התחלת תגובה
* @param param-name description
* תיאור @return
*/
/** * * Calculates the average of three integers. * @author Pratik Agarwal * @version 1.0 * @since 2017-02-18 */ public class FindAvg{ /** * Finds average of three integers. * @param numA First parameter * @param numB Second parameter * @param numC Third parameter * @return Average of numA numB and numC */ public int findAvg(int numA int numB int numC) { return (numA + numB + numC) / 3; } /** * Main method which uses findAvg method * @param args Unused */ public static void main(String args[]){ FindAvg obj = new FindAvg(); int avg = obj.findAvg(10 20 30); System.out.println('Average of 10 20 and 30 is: ' + avg); } }
תְפוּקָה
Average of 10 20 and 30 is: 20
מאמר קשור: כלי JavaDoc
סנטוס נגד rhel