تحليل شامل للشروح والتعليقات في جافا

التعليقات التوضيحية
1. ما هو التعليق التوضيحي؟ (التعليق التوضيحي أو التعليقات)
التعليقات التوضيحية ، يجب أن تكون الترجمة الدقيقة - التعليق التوضيحي. إنه مختلف تمامًا عن التعليقات.
التعليقات التوضيحية هي ميزة قدمها JDK5.0 والإصدارات الأحدث. إنه في نفس المستوى مثل الفئات والواجهات والتعدادات ويمكن أن تصبح نوعًا من Java.
يبدأ بناء الجملة بـ @،
التعليقات هي بعض الأوصاف المحفوظة أو الفريدة التي يقدمها مبرمجون فئات التعليمات البرمجية المصدرية ، والأساليب ، والخصائص ، وما إلى ذلك (مثل ما يتم استخدام هذه الطريقة) ، وهي للناس أن يروا.
التعليقات التوضيحية هي الجزء الذي يمكن أن يفهمه برنامج التحويل البرمجي Java وهو أن يرى المترجم.
دعنا نقدم مثالاً بسيطاً لرؤية استخدام ووظيفة التعليقات التوضيحية.
Override هو شرح شائع Java المدمج. تتمثل وظيفتها في التحقق مما إذا كانت الطرق المحددة في الفئة الفرعية صحيحة عند تجميع الكود.

 شرح الحزمة ؛ Public Abstract Class Animal {public Abstract void eat () ؛ } شرح الحزمة ؛ Class Class Cat يمتد Animal {Override Public Void Eat (سلسلة الطعام) {}}

هنا ، في القطة الفرعية ، يتم شرح طريقة EAT كطريقة تكتب فئة الأصل ، ولكن لديها معلمة واحدة أكثر من طريقة الفئة الأصل.
إذا كنت تقوم بالتحرير في Eclipse ، فستكون هناك موجه صليب أحمر. (لن يتم تمرير تجميع الكود).
إذا قمت بإزالة تعليق توضيحي Override ، فلا توجد مشكلة في التجميع ، ولكن طريقة EAT في CAT هي طريقة جديدة لهذه الفئة ، وليس موروثة من الفئة الأم.

2. التعليقات التوضيحية المشتركة Java
بما في ذلك Override ، ما هي التعليقات التوضيحية المشتركة الأخرى Java؟
1. deprecated
لا ينصح بالشرح ويمكن استخدامه على الأساليب والفصول.
في الأساس ، يتم التخلي عن هذه الطريقة والفئة ولا ينصح بها لبعض الأسباب مثل الترقية أو الأداء ، ولكن يجب الاحتفاظ بها لتوافق أو أسباب أخرى.
لذا ضع هذا التعليق التوضيحي عليه.
هناك العديد من هذه الأمثلة في Java نفسها API. إذا وضعت هذا التعليق التوضيحي على الطريقة ، فسترى الطريقة البديلة الجديدة.
عند كتابة التعليمات البرمجية في Eclipse ، ستضيف الطريقة التي تضيف هذه التعليقات التوضيحية إلى كل من الإعلان والاتصال.

2.@تجاوز

3.@CropressWarnings
تجاهل التحذيرات.
إذا كان الكود الخاص بك يحتوي على بعض التحذيرات في التحول أو أجزاء أخرى ، لكنك تريد تجاهل هذه التحذيرات ، فيمكنك استخدام هذا التعليق التوضيحي.
1) تحذير عندما يستخدم الإهمال فئة أو طريقة غير مفضلة

2) تحذير غير محدد عند إجراء تحويل غير محدد

3) تظهر تحذيرات السقوط عند عدم إضافة عملية الاستراحة بعد استخدام القضية ، مما تسبب في مواصلة البرنامج في تنفيذ بيانات الحالة الأخرى

4) تحذير المسار عند تعيين مسار ملف فائق أو مسار ملف غير صحيح

5) التحذير التسلسلي عندما يكون التعريف التسلسلي مفقودًا على الطبقة التسلسلية

6) تحذير حرفي إذا كان أي شرط أخيرًا لا يمكن إكماله بشكل طبيعي

7) جميع التحذيرات حول كل المواقف المذكورة أعلاه

3. التعليقات التوضيحية المخصصة
بالإضافة إلى التعليقات التوضيحية المدمجة التي توفرها Java نفسها ، توفر Java أيضًا وظيفة تخصيص التعليقات التوضيحية المخصصة.
طريقة تحديد التعليقات التوضيحية هي استخدام التعليقات التوضيحية لتحديد التعليقات التوضيحية. وتسمى التعليقات التوضيحية المستخدمة لتحديد التعليقات التوضيحية التعليقات التوضيحية.
التعليقات التوضيحية الرئيسية هي كما يلي: @target ؛ @حفظ؛ documented ؛ inherited
1. @target يشير إلى مكان استخدام التعليق التوضيحي ، ويمكن استخدامه في الفئات أو الأساليب أو السمات. تشمل معلمات elemenettype الممكنة:
Elemenettype.Constructor إعلان
إعلان مجال Elemenettype.field (بما في ذلك حالات التعداد)
elemenettype.local_variable إعلان متغير محلي
elemenettype.method method إعلان
Elemenettype.Package بيان حزمة
Elemenettype.Parameter Parameter إعلان
فئة elemenettype.type ، واجهة (بما في ذلك نوع التعليق التوضيحي) أو إعلان التعداد
2. يشير الاحتفاظ به إلى أي مستوى لحفظ معلومات التعليقات التوضيحية. تتضمن المعلمات الاختيارية للاحتفاظ بالسياسة ما يلي:
سيتم التخلص من التعليقات التوضيحية للاحتفاظ
entrypolicy.class شرح متاح في ملف الفصل ، ولكن سيتم تجاهله بواسطة VM.
سيحتفظ RestenePolicy.Runtime VM أيضًا بالتعليقات أثناء وقت التشغيل ، بحيث يمكن قراءة معلومات التعليقات التوضيحية من خلال آلية الانعكاس.
3. documented ، سواء لتضمين هذا التعليق عند إنشاء DOC ، قم بتضمين هذا التعليق التوضيحي في Javadoc
4. inherited
دع الفئات الفرعية ترث التعليقات التوضيحية في الفصل الأصل ترى بعض أمثلة التعريف البسيطة:

 شرح الحزمة ؛ استيراد java.lang.annotation.documented ؛ استيراد java.lang.annotation.elementType ؛ استيراد java.lang.annotation.inherited ؛ استيراد java.lang.annotation.Reentering ؛ استيراد java.lang.annotation.RetentionPolicy ؛ استيراد java.lang.annotation.target ؛ target (elementType.method) public interface myannotation {string value () ؛ } @repinention (attreentionpolicy.source) interface myannotation1 {} @repintion

4. استخدم الأمثلة:

 شرح الحزمة ؛ استيراد java.lang.annotation.annotation ؛ @myannotation3 الفئة العامة testannotation {public static void main (string [] args) {// todo method method method method anotation = testannotation.class.getAnnotation (myannotation3.class) ؛ System.out.println (enrotation.toString ()) ؛ }}

اطبع النتيجة: @endation.myannotation3 ()
إذا تم استبدال myannotation1 و myannotation2 في المثال أعلاه ، فإن قيمة التعليقات التوضيحية التي تم الحصول عليها فارغة ، وهذا هو الفرق بين entrentionpolicy.

خامسا دور التعليق التوضيحي

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

 Column ("AA") سلسلة خاصة XX ؛

يشبه هذا تكوين XML ، والذي يبسط التكوين في البرنامج ويحرك جزءًا من البيانات الوصفية من ملف XML إلى الكود نفسه ، ويديره ويحافظ عليه في مكان واحد.
كيف يتم تنفيذها داخليًا؟ - آلية انعكاس جافا ، على غرار المثال أعلاه.

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

 /**************************************************************************************** المستخدم ********************************************************************************

يبدو أن هذا ملاحظة جيدة^^.

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

1. التعليقات القياسية على طرق فئة Java
لنبدأ بالتعليقات على طريقة الفصل.

 /*** اقرأ سطر النص. يعتبر الخط الذي يتم إنهاءه بواسطة أي واحد * من خلاصة الخط ('/n') ، أو عودة النقل ('/r') ، أو عودة عربة * تليها مباشرة بواسطة خط. * * param agnorelf1 إذا كان ذلك صحيحًا ، فسيتم تخطيه التالي '/n' <code_snippet_id = "74911" snippet_file_name = "blog_20131120_2_8365599" name = "code"> * param arghrelf2 إذا كان ذلك صحيحًا/n 'سوف يكون متخلفًا </pre> * * أي أحرف من نهاية الخط ، أو خالية إذا تم الوصول إلى نهاية الدفق * * * see java.io.linenumberreader#readline () * * exception ioException إذا حدث خطأ I/O */

(لا تهتم بمعنى التعليقات أعلاه ، ما عليك سوى التركيز على أسلوب تعريفه)
1. انظر أولاً إلى الجزء العلوي "اقرأ خطًا من النص. خط ..". هذه الفقرة هي وصف لهذه الطريقة.

الجزء قبل الفترة الأولى ، وهو "قراءة سطر النص". سوف يظهر في "ملخص الطريقة"

2. Param يحدد معلمات الإدخال للطريقة ، والتي (يمكن إضافة متعددة) تظهر في "تفاصيل الطريقة". (يتم فصل المعلمة والمعلمة عن طريق المسافات ، ويتم تحويلها إلى - في المستند الذي تم إنشاؤه)

3. @عائد وصف قيمة الإرجاع
4. see exireded description
5. وصف exception الذي تم إلقاؤه بواسطة استثناء جميل. يمكن عرض أنواع مختلفة من العلامات في سطر واحد ، مثل param و @RETURN فارغة مباشرة سطر واحد.

2. جافا فئة التعليقات القياسية
شكل التعليقات التوضيحية والتعليقات التوضيحية للطبقة هو نفسه. ما هو الفرق:
1. الموضع مختلف. يتم وضع التعليقات التوضيحية الفئة فوق تعريف الفئة ، ويتم وضع التعليقات التوضيحية للأسلوب فوق تعريف الطريقة.
2. يستخدم مقارنة التعليقات التوضيحية للفئة علامات مثل VersionAuthor since.
انظر إلى القالب

 /** سوف تخزن الإدخال من الملف المحدد. بدون التخزين المؤقت ، يمكن أن يتسبب كل الاحتجاج في read () أو readline () في قراءة بايت من الملف * ، وتحويله إلى أحرف ، ثم يتم إرجاعه ، والذي يمكن أن يكون متأصلًا جدًا. * * اختبار الوصف * * <p> البرامج التي تستخدم datainputStreams للإدخال النصية يمكن توطينها عن طريق * استبدال كل datainputStream باستخدام bufferreader المناسب. * * see filereader * see inputstreamreader * * version 0.1 ، 11/20/13 * Author Oscar999 * since jdk1.5 */

التأثيرات المعروضة في DOC هي:
وبالمثل ، تظهر الجملة الأولى من الوصف في "الفصل".

يتم عرض تفاصيل الفصل على النحو التالي:

تجدر الإشارة إلى أن استخدام <p> في الوصف. إذا لم تتم إضافة <p> ، بغض النظر عما إذا كان هناك سطر جديد في رمز Java ، فلن يكون المستند الذي تم إنشاؤه جديدًا. إذا تمت إضافة <p> ، يظهر خط جديد في Doc.

3. ملحق
للإضافة ، طريقة توليد Javadoc:
1. طريقة السطر المسماة: معلمات Javadoc +

2. استخدم Eclipse IDE للتصدير إذا كان في Eclipse IDE ، انقر بزر الماوس الأيمن على الملف المصدر أو المشروع ، حدد التصدير --->
Java -> يمكن إنشاء Javadoc.