من المهم جدًا لمطوري البرامج إرفاق التعليقات على الكود. مع تطوير التكنولوجيا ، يجب أن يُطلب من المبرمجين كتابة تعليقات التعليمات البرمجية أثناء تطوير المشروع ، والتي تفضي إلى الكتابة اللاحقة واستخدام الكود.
المتطلبات الأساسية:
1. نموذج التعليق الموحد
في جميع أنحاء التطبيق ، استخدم الأنماط مع علامات الترقيم والبنية المتسقة لبناء التعليقات التوضيحية. إذا وجدت أن مواصفات التعليقات التوضيحية الخاصة بهم تختلف عن هذا المستند في مشاريع أخرى ، فاكتب رمزًا وفقًا لهذه المواصفات ولا تحاول إدخال مواصفات جديدة في نظام المواصفات المحدد.
2. محتوى التعليق دقيق وموجز
يجب أن يكون المحتوى بسيطًا وواضحًا ودقيقًا ، ويجب منع المعنى من غموض التعليقات. التعليقات غير الصحيحة ليست عديمة الفائدة فحسب ، بل ضارة أيضًا.
3. التعليقات الأساسية (يجب إضافة)
(أ) تعليقات للفصل (واجهة)
(ب) تعليق المنشئ
(ج) تعليقات على الأساليب
(د) تعليقات المتغيرات العالمية
(هـ) ملاحظات للحقول/السمات: رمز بسيط يقدم تعليقات بسيطة ، ومحتوى التعليق لا يزيد عن 10 كلمات ، وبالإضافة إلى ذلك ، تستمر الكائنات أو
لا تحتاج إلى التعليق على أساليب getter و setter لكائنات VO. لتنسيقات شرح محددة ، يرجى الرجوع إلى الأمثلة التالية.
4. يجب إضافة تعليقات خاصة (يجب إضافة)
(أ) يجب التعليق على الخوارزميات النموذجية.
(ب) يجب أن يتم التعليقات في رمز غير واضح.
(ج) إضافة تعليق إلى علامة التعديل في تعديل الكود.
(د) التعليق في الكود المكون من الحلقات والفروع المنطقية.
(هـ) يجب التعليق على الواجهات المقدمة للآخرين بالتفصيل.
ملاحظة: لا توجد أمثلة لهذا النوع من تنسيق التعليقات. يتم تعريف تنسيق التعليقات التوضيحية المحددة من قبل نفسك ، ويحتاج محتوى التعليق التوضيحي ليكون دقيقًا وموجزًا.
5. تنسيق التعليق:
1) تعليق خط واحد: "// ..."
2) تعليق التعليق: "/*...*/"
3) تعليقات الوثيقة: "/** ...*/"
4) بناء جملة علامة تعليق Javadoc
Author وصف الفئة يشير إلى المؤلف الذي طور وحدة الفئة
version وصف الفئة يشير إلى إصدار وحدة الفئة
see @مرجع تحول إلى وصف الفصول والخصائص والأساليب ، أي الموضوعات ذات الصلة
param وصف طريقة وصف المعلمة في طريقة
regurn وصف طريقة وصف طريقة إرجاع الطريقة
exception الوصف لوصف الطريقة للاستثناءات التي قد يتم إلقاؤها بالطريقة
6. مثال:
/** قم بإنشاء فئة أدوات لمعالجة المصفوفات ، والتي تحتوي على هذه الوظيفة المشتركة لتشغيل المصفوفات: الأكثر قيمة. Author Zhang SAN @الإصدار v. */ الفئة العامة ArrayTool {/ ** احصل على القيمة القصوى لمصفوفة تشكيل @param arr الحصول على مجموعة من عناصر من النوع int regurn الحد الأقصى لقيمة العنصر للمصفوعة */ public int getMax (int arr) {int max = ؛ إرجاع ماكس ؛ }}أدخل الأمر كما هو موضح أدناه:
ثم تحقق من ذلك في الدليل التالي وأخيراً انقر فوق index.html:
يشارك المحتوى أعلاه مواصفات التعليقات Java Code معك ، على أمل أن تكون مفيدة لك.