كيفية استخدام التعليقات في قانون جافا

تعليقات Java هي ملاحظات في ملف Java code يتم تجاهلها بواسطة المترجم ومشغل وقت التشغيل. يتم استخدامها لتوضيح الكود من أجل توضيح تصميمه والغرض منه. يمكنك إضافة عدد غير محدود من التعليقات إلى ملف Java ، ولكن هناك بعض "أفضل الممارسات" التي يجب اتباعها عند استخدام التعليقات.

بشكل عام ، تعليقات الكود هي تعليقات "تنفيذ" تشرح مصدر الرمز، مثل أوصاف الفئات والواجهات والأساليب والحقول. عادة ما يكون هذا عبارة عن سطرين مكتوبين فوق أو بجانب كود Java لتوضيح ما يفعله.

نوع آخر من تعليقات Java هو تعليق Javadoc. تختلف تعليقات Javadoc قليلاً في بناء الجملة عن تعليقات التنفيذ وتستخدم من قبل برنامج javadoc.exe لتوليد وثائق HTML HTML.

من الممارسات الجيدة الاعتياد على وضع تعليقات Java في شفرة المصدر لتحسين قابليتها للقراءة والوضوح لنفسك وللمبرمجين الآخرين. ليس من الواضح دائمًا على الفور ما يقوم به قسم من كود Java. يمكن أن تقلل بعض الخطوط التفسيرية بشكل كبير من مقدار الوقت المستغرق لفهم الشفرة.

تعليقات التنفيذ في كود جافا هناك فقط لقراءة البشر. لا يهتم مترجمو جافا بهم ومتى

تأتي تعليقات التنفيذ بصيغتين مختلفتين:

• تعليقات الخط: للحصول على تعليق من سطر واحد ، اكتب "//" واتبع الخطين المائلين للأمام مع تعليقك. فمثلا:

   / / هذا تعليق سطر واحد
  int guessNumber = (int) (Math.random () * 10) ؛ 

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

  •  / / هذا تعليق سطر واحد
    // int guessNumber = (int) (Math.random () * 10) ؛ 

    يمكنك أيضًا استخدام الخطين المائلين الأماميين لتعليق نهاية السطر:

  •  / / هذا تعليق سطر واحد
    int guessNumber = (int) (Math.random () * 10) ؛ // نهاية سطر التعليق 

• حظر التعليقات: لبدء تعليق كتلة ، اكتب "/ *". كل شيء بين الخط المائل للأمام ونجمة ، حتى لو كان في سطر مختلف ، يتم التعامل معه كتعليق حتى تنتهي الأحرف "* /" من التعليق. فمثلا:

   /* هذه 
  يكون 
  أ
  منع
  تعليق
  */
  /* هكذا هذا */
  

استخدم تعليقات Javadoc الخاصة لتوثيق Java API. Javadoc هي أداة مضمنة في JDK تقوم بإنشاء وثائق HTML من التعليقات في التعليمات البرمجية المصدر.

تعليق Javadoc في

.جافا

/**

*/

*

ضع هذه التعليقات أعلى الطريقة أو الفئة أو المنشئ أو أي عنصر Java آخر تريد توثيقه مباشرةً. فمثلا:

// myClass.java
/**
* اجعل هذا جملة موجزة تصف صفك.
* هنا خط آخر.
*/
عامةصف دراسي صفي
{
...
}

يتضمن Javadoc العديد من العلامات التي تتحكم في كيفية إنشاء الوثائق. على سبيل المثال ، فإن

@ بارام

 / ** الطريقة الرئيسية
*param args String []
*/​
عامةثابتةباطل الحجج الرئيسية (سلسلة [])
​{
System.out.println ("Hello World!") ؛
}

تتوفر العديد من العلامات الأخرى في Javadoc ، كما تدعم علامات HTML للمساعدة في التحكم في الإخراج. راجع وثائق Java للحصول على مزيد من التفاصيل.

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

   /* هذه 
  يكون
  / * ينتهي تعليق الكتلة هذا التعليق الأول * /
  أ
  منع
  تعليق
  */