مقدمة مفصلة لشروح جافا

مقدمة إلى التعليقات التوضيحية لجافا

لا شك أن تطوير Java القائم على التعليقات التوضيحية هو أحدث اتجاهات التطوير. [ملاحظة المترجم: هذه مقالة من عام 2005. في عام 2014، ليس هناك شك في أن استخدام التعليقات التوضيحية أصبح حلاً جيدًا للتطوير التعاوني متعدد الأشخاص بطريقة، يمكن أن يكون التأثير المتبادل والاقتران منخفضًا جدًا].

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

تعد تعليقات Java التوضيحية إحدى الميزات الرئيسية في JDK 5، مما يجعل التطوير أبسط وأسهل، تشبه التعليقات التوضيحية نوعًا من المعلومات الوصفية (التي يمكن فهمها على أنها معلومات إضافية يمكن لبرامج خاصة رؤيتها) ويمكن إضافتها إلى التعليمات البرمجية. ، يمكن استخدامه في إعلانات الحزمة وإعلانات النوع والمنشئات والطرق والحقول والمعلمات والمتغيرات. إنها توفر طريقة فعالة للإشارة إلى ما إذا كانت الطريقة تعتمد على طرق أخرى، أو أنها مكتملة، أو ما إذا كان الفصل يشير إلى فئات أخرى، وما إلى ذلك.

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

ببساطة، التعليقات التوضيحية هي آلية تربط العلامات الوصفية بعناصر البرنامج، مما يسمح للمترجم أو JVM باستخراج سلوك البرنامج من العناصر المشروحة وإنشاء تعليمات برمجية مترابطة عند الضرورة.

في الجزء الأول من هذه السلسلة من المقالات، سأقدم بعض التعليقات التوضيحية الأساسية لجافا، وفوائدها، وبعض الأمثلة على الاستخدامات.

أساسيات التعليقات التوضيحية في جافا

عليك أن تفهم شيئين. أحدهما هو "التعليق التوضيحي" (يشبه كائنًا جديدًا) نفسه، والآخر هو "نوع التعليق التوضيحي" (نوع التعليق التوضيحي، الذي يشبه تعريف الفئة). المستخدمة في التعليمات البرمجية الخاصة بك، لديها في الواقع دورة حياة ونطاق التطبيق. يتم استخدام نوع التعليق التوضيحي لتحديد التعليقات التوضيحية. النوع هو النوع المُنشأ الفعلي المُستخدم، والتعليق التوضيحي هو مجرد استخدام محدد لهذا النوع.

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

مثال على تعريف نوع التعليق التوضيحي: (نوع التعليق التوضيحي، نوع التعليق التوضيحي، يشبه تعريف فئة)

انسخ رمز الكود كما يلي:
@interface MyAnnotation {
سلسلة تفعل شيئا ()؛
}

استخدام التعليقات التوضيحية (مثيلات التعليقات التوضيحية) في الكود العادي

انسخ رمز الكود كما يلي:
@MyAnnotation (doSomething="ما يجب القيام به")
طريقة الفراغ العام () {
....
}

أنواع التعليقات التوضيحية في Java (أنواع التعليقات التوضيحية)

هناك ثلاثة أنواع من التعليقات التوضيحية:

العلامة: لا تحتوي التعليقات التوضيحية لنوع العلامة على عناصر، بل اسم فقط.

تعريف:

انسخ رمز الكود كما يلي:
// هذا النوع من التعليقات التوضيحية يشبه التصنيف، بدون حالة
// يشبه إلى حد ما الواجهة القابلة للتسلسل بدون تعريف الطريقة
@interface AMarkerAnnotation {
}

يستخدم:
انسخ رمز الكود كما يلي:
@AmarkerAnnotation
طريقة الفراغ العام () {
....
}

التعليقات التوضيحية ذات العنصر الواحد: تحمل التعليقات التوضيحية ذات العنصر الواحد أو القيمة الواحدة بيانات واحدة فقط، ويمكن التعبير عنها كبيانات = قيمة بين قوسين، أو يمكن تمرير قيمة واحدة فقط (طريقة كتابة بسيطة).

تعريف:
انسخ رمز الكود كما يلي:
public @interface SingleElementAnnotation
{
سلسلة تفعل شيئا ()؛
}

يستخدم:
انسخ رمز الكود كما يلي:
@SingleElementAnnotation ("يمكنك فقط تمرير قيم من النوع المقابل")
طريقة الفراغ العام () {
....
}

التعليقات التوضيحية ذات القيمة الكاملة أو متعددة القيم: تحتوي التعليقات التوضيحية من نوع القيمة الكاملة على أعضاء بيانات متعددين، لذلك، يجب تمرير المعلمات باستخدام تنسيق بناء جملة البيانات الكاملة = القيمة لكل عضو.

تعريف:
انسخ رمز الكود كما يلي:
@interface FullValueAnnotation {
سلسلة تفعل شيئا ()؛
عدد كثافة العمليات؛
تاريخ السلسلة ()؛
}

يستخدم:
انسخ رمز الكود كما يلي:
@FullValueAnnotation (doSomething = "قيمة المعلمة"، العدد = 1،
التاريخ = "09-09-2005")
طريقة الفراغ العام () {
....
}

اعتبارات لتحديد أنواع التعليقات التوضيحية لـ Java

الأشياء التي يجب ملاحظتها عند تحديد أنواع التعليقات التوضيحية:

1. يجب أن يبدأ إعلان التعليق التوضيحي بالرمز (@)، متبوعًا بكلمة أساسية للواجهة، واسم التعليق التوضيحي.
2. لا يقبل إعلان الطريقة في التعليق التوضيحي أي معلمات (يبدو كطريقة فقط، ولكنه في الأساس مجال سمة).
3. لا يمكن أن يحتوي إعلان الطريقة في التعليق التوضيحي على جملة رميات.
4. أنواع إرجاع الطريقة في التعليقات التوضيحية يمكن أن تكون كما يلي فقط:
@primitives (6 أنواع بيانات بدائية، int، byte، وما إلى ذلك)
@سلسلة (سلسلة)
@Class(فئة، مثل String.class)
@التعداد(التعداد)
@array من الأنواع المذكورة أعلاه (المصفوفة، يمكن أن تكون عناصر المصفوفة واحدة فقط من الأنواع المذكورة أعلاه)

أنواع التعليقات التوضيحية لجافا

هناك نوعان من التعليقات التوضيحية في JDK5:

1. التعليقات التوضيحية البسيطة (أنواع التعليقات التوضيحية البسيطة): هذه هي الأنواع الأساسية التي يوفرها Tiger (Tiger هو الاسم الرمزي لـ JDK1.5؟) ويمكن استخدامها فقط للتعليق على التعليمات البرمجية العادية؛ ولا يمكن استخدامها لإنشاء نوع تعليق توضيحي مخصص آخر .

2. التعليقات التوضيحية: مصممة خصيصًا لتعليق إعلانات أنواع التعليقات التوضيحية الأخرى، ببساطة، تسمى التعليقات التوضيحية.