العلامات المطلوبة لتعليقات الوثائق (دليل برمجة C#)

ويقرأ المترجم C# تعليقات الوثائق في التعليمات البرمجية الخاصة بك وتنسيقها بتنسيق XML في ملف الاسم الذي قمت بتحديده في خيار سطر الأوامر/doc. لإنشاء الوثائق النهائية المستندة إلى ملف مُولد من برنامج التحويل البرمجي، يمكنك إنشاء أداة مخصصة أو استخدم أداة مثل Sandcastle.

تتم معالجة بنية التعليمات البرمجية مثل أنواع العلامات ونوع الأعضاء.

ملاحظة

لا يمكن تطبيق تعليقات الوثائق على مساحة الاسم.

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

العلامات

<c>	<para>	راجع acd0tfbe(v=vs.100).md
<code>	<param>*	<seealso>*
<example>	<paramref>	<summary>
<‏‏ استثناء>*	<إذن>*	<نوع المعلمة>*
<تضمين>*	<remarks>	<نوع المعلمة mref>
<list>	<returns>	value<ا

(* تشير إلى أن المحول البرمجي تحقق من بناء الجملة.)

إذا كنت ترغب في أقواس معقوفة لتظهر في نص تعليق الوثائق, استخدم &amplt; و &ampgt;. على سبيل المثال، &amplt; نص في أقواس معقوفة &ampgt;.

راجع أيضًا:

المرجع

/doc (خيارات المحول البرمجي# C)

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

المبادئ

دليل البرمجة لـ #C