توفير تعليقات تعليمات برمجية XML

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

[Visual Basic]

تعليقات تعليمات برمجية XML متوفر في Visual أساسى من خلال '''(ثلاث علامات اقتباس مفردة) المحدد. لمزيد من المعلومات، راجع كيفية: إنشاء وثائق XML في Visual Basic.

[C#, J #]

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

• سرد الأعضاء @@@@@

• معلومات عن المعلمة

• معلومات سريعة

لمزيد من المعلومات، راجع تعليقات الوثائق XML (C# البرمجة الدليل).

[C++]

بشكل افتراضي، "أية تعليقات في المصدر تعليمات برمجية التي تستخدم//أو/* محددات معروضة بجانب إلى عضو المقترنة بها في قائمة الأعضاء. للمزيد من المعلومات، راجع C++ Comments وXML Documentation (Visual C++).

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

1. ويعرض التحسس الذكي أولاً إنهاء السطر التعليقات في إعلان. فعلى سبيل المثال:

   void MyFunction();   //EOL declaration comments
   

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

   //Before declaration comments
      void MyFunction();
   

3. إذا كان كلاهما السابق أنواع التعليقات غير موجودة في التعليمة البرمجية، يعرض التحسس الذكي طرف الخط تعليقات في التعريف. فعلى سبيل المثال:

   int CMyAppDoc::MyVariable=2; // EOL definition comments
   

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

   //Before definition comments
   CMyAppDoc::MyFunction() 
   {
      return; 
   }
   

راجع أيضًا:

المرجع

سرد الأعضاء @@@@@

موارد أخرى

استخدام خاصية التحسس الذكي