<include> (دليل البرمجة لـ #C)

<include file='filename' path='tagpath[@name="id"]' />

المعلمات

• filename
  اسم ملف الـ XML يحتوي على الوثائق. يمكن أن يكون اسم الملف مؤهلاً بمسار. قم بإحاطة filename في علامات اقتباس فردية (' ').

• tagpath
  مسار العلامات في filename يؤدي إلى علامة name. قم بتضمين المسار بين علامات اقتباس فردية.

• name
  محدد الاسم في العلامة التي تسبق التعليقات; name سيكون لديها id.

• id
  معرف العلامة التي تسبق التعليقات. ضع المعرف ضمن علامات اقتباس مزدوجة.

ملاحظات

تُمكّنك علامة <include> من الإشارة إلى التعليقات في ملف آخر تصف الأنواع والأعضاء في التعليمات البرمجية للمصدر. وهذا بديل من وضع تعليقات الوثائق مباشرة في ‏ملف التعليمات البرمجية للمصدر. عن طريق وضع الوثائق في ملف منفصل يمكنك تطبيق التحكم بالمصادر لوضع الوثائق في ملف منفصل عن التعليمات البرمجية للمصدر. يمكن لشخص أن يقوم بفحص ملف التعليمات البرمجية للمصدر بينما يقوم شخص آخر بفحص ملف الوثائق.

تستخدم علامة <include> بناء الجملة XML XPath. راجع وثائق XPath لمعرفة الطرق التي تخصص استخدامك لـ <include>.

مثال

هذا مثال لعدّة ملفات. الملف الأول والذي يستخدم <include> مدرج بالقائمة أدناه:

// compile with: /doc:DocFileName.xml 

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
class Test
{
    static void Main()
    {
    }
}

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' />
class Test2
{
    public void Test()
    {
    }
}

الملف الثاني xml_include_tag.doc يحتوي على تعليقات الوثائق التالية:

<MyDocs>

<MyMembers name="test">
<summary>
The summary for this type.
</summary>
</MyMembers>

<MyMembers name="test2">
<summary>
The summary for this other type.
</summary>
</MyMembers>

</MyDocs>

مخرجات البرنامج

يتم إنشاء المخرجات التالية عند التحويل البرمجي للفئات Test و Test2 باستخدام سطر الأوامر التالي: /doc:DocFileName.xml. في Visual Studio يعين خيار تعليقات مستندات XML في جزء "البناء" (Build) من مصمم المشروع (Project Designer). عندما يشاهد مترجم #C علامة <include> سيقوم بالبحث عن تعليقات الوثائق في xml_include_tag.doc بدلاً من ملف المصدر الحالي. ثم ينشئ المحول البرمجي DocFileName.xml وهذا هو الملف الذي يتم استهلاكه في أدوات الوثائق مثل Sandcastle لإنتاج الوثائق النهائية.

<?xml version="1.0"?> 
<doc> 
    <assembly> 
        <name>xml_include_tag</name> 
    </assembly> 
    <members> 
        <member name="T:Test"> 
            <summary> 
The summary for this type. 
</summary> 
        </member> 
        <member name="T:Test2"> 
            <summary> 
The summary for this other type. 
</summary> 
        </member> 
    </members> 
</doc> 

راجع أيضًا:

المرجع

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

المبادئ

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