TechCodeview

ה Java הערות הן ההצהרות בתוכנית שאינן מבוצעות על ידי המהדר והמתורגמן.

מדוע אנו משתמשים בהערות בקוד?

• הערות משמשות כדי להפוך את התוכנית לקריאה יותר על ידי הוספת פרטי הקוד.
• זה מקל על תחזוקת הקוד ומציאת השגיאות בקלות.
• ניתן להשתמש בהערות כדי לספק מידע או הסבר על מִשְׁתַנֶה , שיטה, מעמד , או כל הצהרה.
• זה יכול לשמש גם כדי למנוע ביצוע של קוד תוכנית בזמן בדיקת הקוד החלופי.

סוגי הערות Java

ישנם שלושה סוגים של הערות ב-Java.

1. הערה בשורה אחת
2. הערה רב קו
3. הערת תיעוד

1) הערת Java Single Line

ההערה בשורה אחת משמשת להערה רק בשורה אחת של הקוד. זוהי הדרך הנפוצה והקלה ביותר להעיר את ההצהרות.

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

תחביר:

 //This is single line comment 

בוא נשתמש בהערה בשורה אחת בתוכנית Java.

CommentExample1.java

 public class CommentExample1 { public static void main(String[] args) { int i=10; // i is a variable with value 10 System.out.println(i); //printing the variable i } } 

תְפוּקָה:

 10 

2) הערת Java Multi Line

ההערה מרובת השורות משמשת להערה על מספר שורות קוד. ניתן להשתמש בו כדי להסביר קטע קוד מורכב או להערות על מספר שורות קוד בו-זמנית (כיוון שיהיה קשה להשתמש בהערות בשורה אחת שם).

הערות מרובות שורות ממוקמות בין /* ל-*/. כל טקסט בין /* ל-*/ אינו מבוצע על ידי Java.

תחביר:

סנטוס נגד rhel

 /* This is multi line comment */ 

בואו נשתמש בהערה מרובת שורות בתוכנית Java.

CommentExample2.java

 public class CommentExample2 { public static void main(String[] args) { /* Let's declare and print variable in java. */ int i=10; System.out.println(i); /* float j = 5.9; float k = 4.4; System.out.println( j + k ); */ } } 

תְפוּקָה:

 10 

הערה: בדרך כלל // משמש להערות קצרות ו- /* */ משמש להערות ארוכות יותר.

3) הערת תיעוד Java

הערות תיעוד משמשות בדרך כלל לכתיבת תוכניות גדולות עבור פרויקט או יישום תוכנה מכיוון שהיא עוזרת ליצור תיעוד API. ממשקי API אלה נחוצים לעיון, כלומר אילו מחלקות, מתודות, ארגומנטים וכו' משמשים בקוד.

כדי ליצור ממשק API של תיעוד, עלינו להשתמש ב- כלי javadoc . הערות התיעוד ממוקמות בין /** ל-*/.

תחביר:

 /** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */ 

תגיות javadoc

כמה מהתגים הנפוצים בהערות תיעוד:

בואו נשתמש בתג Javadoc בתוכנית Java.

Calculate.java

 import java.io.*; /** * <h2> Calculation of numbers </h2> * This program implements an application * to perform operation such as addition of numbers * and print the result * <p> * <b>Note:</b> Comments make the code readable and * easy to understand. * * @author Anurati * @version 16.0 * @since 2021-07-06 */ public class Calculate{ /** * This method calculates the summation of two integers. * @param input1 This is the first parameter to sum() method * @param input2 This is the second parameter to the sum() method. * @return int This returns the addition of input1 and input2 */ public int sum(int input1, int input2){ return input1 + input2; } /** * This is the main method uses of sum() method. * @param args Unused * @see IOException */ public static void main(String[] args) { Calculate obj = new Calculate(); int result = obj.sum(40, 20); System.out.println(&apos;Addition of numbers: &apos; + result); } } </p>

הידור אותו באמצעות כלי javac:

צור מסמך

צור תיעוד API על ידי javadoc כְּלִי:

כעת, קובצי HTML נוצרים עבור לחשב מחלקה בספרייה הנוכחית, כלומר, abcDemo . פתח את קבצי ה-HTML, ונוכל לראות את ההסבר של Calculate class מסופק דרך הערת התיעוד.

האם הערות Java ניתנות להפעלה?

שנים: כפי שאנו יודעים, הערות Java אינן מבוצעות על ידי המהדר או המתורגמן, אולם לפני הטרנספורמציה המילונית של קוד במהדר, תוכן הקוד מקודד ל-ASCII על מנת להקל על העיבוד.

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println('Java comment is executed!!'); } } 

תְפוּקָה:

הקוד שלמעלה מייצר את הפלט מכיוון שהמהדר מנתח את תו ה-Unicode u000d כ שורה חדשה לפני הטרנספורמציה המילונית, וכך הקוד משתנה כפי שמוצג להלן:

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } 

לפיכך, תו Unicode מעביר את הצהרת ההדפסה לשורה הבאה והיא מבוצעת כקוד Java רגיל.