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

في Visual C# يمكنك إنشاء وثائق للرمز الخاص بك بما في ذلك علامات XML في تعليق خاص حقول الموجودة في مصدر تعليمات برمجية مباشرة من قبل حظر تعليمات برمجية التي تشير إلى. فعلى سبيل المثال:

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

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

ملاحظة

تعليقات مستندات XML ليس بيانات التعريف؛ فإنها غير مضمنة في تجميع المترجمة و ولذلك لم يتم الوصول إليها من خلال الانعكاس.

في هذا القسم

الأقسام ذات الصلة

لمزيد من المعلومات، راجع:

مواصفات لغة #C

لمزيد من المعلومات، راجع مواصفات لغة #C. مواصفات اللغة هي المصدر النهائي لبناء جملة C# واستخدامها.

راجع أيضًا:

المبادئ

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