تعليقات جافا

تعليقات جافا
جربه على ممارسة GfG

التعليقات في 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. يتم استخدامها بشكل عام في المشاريع المهنية لوصف أساليب ومعلمات الفئات.

بناء الجملة:   

/**
* بداية التعليق
* @param وصف الاسم المعلم
* وصف العودة
*/

Java
   /**    *     * 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  

مقالة ذات صلة: أداة جافا دوك


إنشاء اختبار