التعليقات في جافا

التعليقات في Java ، كما هو الحال في معظم لغات البرمجة الأخرى، هي أحرف يتم تجاهلها أثناء تنفيذ البرنامج. وبذلك يمكنك إضافة أكبر عدد ممكن من التعليقات إلى البرنامج حسب الحاجة دون الخوف من زيادة حجمه. تُستخدم التعليقات لوصف تعقيدات مجموعة معينة من التعليمات البرمجية أو الطريقة أو الفئة. يمكنك أيضًا استخدامها إذا كنت تريد ترك رسائل للمبرمجين الذين سيعملون مع هذا الرمز في المستقبل. أو لملاحظاتك الخاصة.

طرق لتسليط الضوء على التعليقات

لدى Java طريقتان لتسليط الضوء على التعليقات في النص.

تعليق التنفيذ (تعليق الكود)

1. تعليق سطر

   هذا هو نوع التعليق الأكثر استخدامًا. لكتابة مثل هذا التعليق، تحتاج إلى استخدام خطين مائلين للأمام //. في هذه الحالة، يبدأ التعليق مباشرة بعد الأحرف //ويستمر حتى نهاية السطر.

   System.out.println("Hello, Java world!");
   // наш комментарий

2. التعليق على كتلة من النص

   إذا كنت بحاجة إلى تعليقات أطول، يمكنك بدء كل سطر بالرموز. على الرغم من أنه من الأفضل قصر كتل التعليقات على المحددات /*و */.

   /*
    Пример простой программы на Java
   */
   
   public class SampleProgram
   {
    public static void main (String [] args)
    {
    System.out.println("Hello, Java world!");
    }
   }

   يجب ألا ننسى أن التعليقات المفصولة بالرموز /*لا يمكن */دمجها في لغة جافا. وهذا يعني أنه لا يمكن تعطيل جزء من التعليمات البرمجية ببساطة عن طريق إحاطته بـ /*و ، نظرًا لأن التعليمات البرمجية التي يتم تعطيلها قد تحتوي في حد ذاتها على */محددات ./**/

توثيق التعليق

لتوثيق الأساليب أو المتغيرات أو الفئات، يتم استخدام طريقة خاصة لتمييز النص. ويتم ذلك باستخدام /**و */. في هذه الحالة، يبدأ كل سطر من النص الذي تم التعليق عليه بـ *إذا تم توثيق طريقة ما، فمن المعتاد وصف وسيطاتها وإرجاع القيمة.

/**
* Метод возвращает максимальное meaning
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
   return Math.max(Math.max(a, b), c);
}

ماذا تقرأ؟ على سبيل المثال، هذه المادة: التعليقات في Java: ليس كل شيء بهذه البساطة . أو محاضرة من مهمة Java Syntax Pro حول التعليقات.