علامات XML مستحسنه لتعليقات وثائق (Visual Basic)

المحول البرمجي Visual Basic يمكن أن يتم عملية تعليقات الوثائق في التعليمات البرمجية لملف XML. يمكنك استخدام أدوات إضافية إلى معالجة ملف XML في الوثائق.

يتم السماح بتعليقات XML على ثوابت التعليمات البرمجية مثل أنواع و نوع الأعضاء. لأنواع الجزئية أن جزء واحد فقط من النوع تعليقات XML بالرغم من وجود عدم تقييد تشغيل بالتعليق أعضائها.

ملاحظة

لا يمكن تطبيق تعليقات الوثائق على مساحة الاسم. السبب في أن مساحة الاسم الواحد تمتد عبر عدة تجميعات و تملك تجميعات ليس الكل يمكنها تحميله في نفس الوقت.

يعالج المحول البرمجي أي علامة يكون مستند XML صالح. العلامات التالية توفر الوظائف المستخدمة بشكل عام في وثائق المستخدم.

<c>	<code>	<example>
<‏‏ استثناء>1	<تضمين>1	<list>
<para>	para >>1	<paramref>
<إذن>1	<remarks>	<returns>
<انظر>1	<انظر أيضا>1	<summary>
<typeparam>1	value<ا

(1 يتحقق المحول البرمجي من بناء الجملة.)

ملاحظة

إذا كنت ترغب في أقواس معقوفة لتظهر في نص تعليق الوثائق, استخدم &lt; و &gt;. على سبيل المثال، سلسلة "&lt;text in angle brackets&gt;" سوف تظهر ك<text in angle brackets>.

راجع أيضًا:

المهام

كيفية القيام بما يلي: إنشاء وثائق XML في Visual Basic

المرجع

doc/

المبادئ

توثيق التعليمات البرمجية الخاصة بك مع XML (Visual Basic)