ال جافا التعليقات هي العبارات الموجودة في البرنامج والتي لا يتم تنفيذها بواسطة المترجم والمترجم.
لماذا نستخدم التعليقات في الكود؟
- تُستخدم التعليقات لجعل البرنامج أكثر قابلية للقراءة عن طريق إضافة تفاصيل الكود.
- يسهل الحفاظ على الكود والعثور على الأخطاء بسهولة.
- يمكن استخدام التعليقات لتقديم معلومات أو شرح حول عامل ، طريقة، فصل ، أو أي بيان.
- ويمكن استخدامه أيضًا لمنع تنفيذ كود البرنامج أثناء اختبار الكود البديل.
أنواع تعليقات جافا
هناك ثلاثة أنواع من التعليقات في Java.
- تعليق سطر واحد
- تعليق متعدد الأسطر
- تعليق التوثيق
1) جافا تعليق سطر واحد
يتم استخدام التعليق المكون من سطر واحد للتعليق على سطر واحد فقط من التعليمات البرمجية. إنها الطريقة الأسهل والأسهل استخدامًا للتعليق على البيانات.
تبدأ التعليقات ذات السطر الواحد بخطين مائلين للأمام (//) . أي نص أمام // لا يتم تنفيذه بواسطة Java.
بناء الجملة:
//This is single line comment
دعونا نستخدم تعليق سطر واحد في برنامج جافا.
تعليقمثال1.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.
بناء الجملة:
الصف مقابل العمود
/* This is multi line comment */
دعونا نستخدم التعليق متعدد الأسطر في برنامج جافا.
تعليقمثال2.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) تعليق وثائق جافا
تُستخدم تعليقات التوثيق عادةً لكتابة برامج كبيرة لمشروع أو تطبيق برمجي لأنها تساعد في إنشاء واجهة برمجة التطبيقات للتوثيق. هناك حاجة إلى واجهات برمجة التطبيقات هذه كمرجع، أي الفئات والأساليب والوسائط وما إلى ذلك المستخدمة في التعليمات البرمجية.
لإنشاء واجهة برمجة تطبيقات التوثيق، نحتاج إلى استخدام أداة جافادوك . يتم وضع تعليقات التوثيق بين /** و */.
بناء الجملة:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
علامات جافادوك
بعض العلامات شائعة الاستخدام في التعليقات التوثيقية:
بطاقة شعار | بناء الجملة | وصف |
---|---|---|
{@docRoot} | {@docRoot} | لتصوير المسار النسبي إلى الدليل الجذر للمستند الذي تم إنشاؤه من أي صفحة. |
@مؤلف | @ اسم المؤلف - النص | لإضافة مؤلف الفصل. |
@شفرة | {@نص الكود} | لإظهار النص بخط التعليمات البرمجية دون تفسيره على أنه علامة html أو علامة javadoc متداخلة. |
@إصدار | @ نسخة نسخة النص | لتحديد العنوان الفرعي 'الإصدار' ونص الإصدار عند استخدام خيار -version. |
@منذ | @ منذ الإصدار | لإضافة عنوان 'منذ' مع النص إلى الوثائق التي تم إنشاؤها. |
@param | @param وصف اسم المعلمة | لإضافة معلمة بالاسم والوصف المحددين إلى قسم 'المعلمات'. |
@يعود | @ وصف العودة | مطلوب لكل طريقة تقوم بإرجاع شيء ما (باستثناء الفراغ) |
دعونا نستخدم علامة Javadoc في برنامج Java.
احسب.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('Addition of numbers: ' + result); } } </p>
تجميعها باستخدام أداة javac:
إنشاء مستند
إنشاء واجهة برمجة تطبيقات التوثيق بواسطة javadoc أداة:
الآن، يتم إنشاء ملفات HTML لـ احسب فئة في الدليل الحالي، أي، abcDemo . افتح ملفات HTML، ويمكننا أن نرى شرح حساب الفئة المقدم من خلال تعليق التوثيق.
هل تعليقات Java قابلة للتنفيذ؟
أعوام: كما نعلم، لا يتم تنفيذ تعليقات Java بواسطة المترجم أو المترجم، ومع ذلك، قبل التحويل المعجمي للكود في المترجم، يتم تشفير محتويات الكود إلى ASCII من أجل تسهيل المعالجة.
اختبار.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 ك خط جديد قبل التحويل المعجمي، وبالتالي يتم تحويل الكود كما هو موضح أدناه:
اختبار.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 عادي.