كيفية القيام بما يلي: تعريف ملف تعريف لتوسيع UML

في Visual Studio Ultimate ، يمكنك تعريف ملف تعريف UML لتخصيص عناصر الطراز القياسية لأغراض معينة. ملف التعريف يقوم بتعريف عدة فئات فرعية لـ UML. الفئة الفرعية يمكن استخدامها لتوسيع قائمة عنصر ما من الخصائص.

يتم تثبيت ملفات تعريف عدة باستخدام Visual Studio Ultimate. للحصول على مزيد من المعلومات حول ملفات تعريف تلك و كيفية تطبيق الفئات الفرعية, راجع تخصيص الطراز الخاص بك بملفات التعريف و الفئات.

يمكنك تعريف التشكيلات الجانبية الخاصة بك لملائمة وتوسيع UML في منطقة العمل أو البنية الخاصة بك. فعلى سبيل المثال:

• إذا عرّفت بشكل متكرر مواقع ويب، يمكنك تعريف ملف التعريف الخاص بك الذي يوفر الفئة الجانبية «صفحة ويب» التي يمكن تطبيقها إلى الفئات في مخططات الفئة. يمكنك بعد ذلك استخدام مخططات الفئة لتخطيط موقع ويب. تحتوي كل فئة «صفحة ويب» على على خصائص إضافية لمحتوى الصفحة وهكذا.

• إذا قمت بتطوير البرامج المصرفية, يمكنك تعريف ملف تعريف و الذي يوفر فئة فرعية «حساب». يمكنك بعد ذلك استخدام مخططات الفئة لتعريف أنواع مختلفة من الحسابات و إظهار العلاقات بينها.

يمكنك توزيع ملفات التعريف الخاصة بك على الفريق الخاص بك. يمكن لكل عضو فريق تثبيت ملف التعريف الخاص بك. وهذا يمكّنهم من تحرير وإنشاء طرازات تستخدم الفئات الفرعية الخاصة بها.

ملاحظة

إذا قمت بتطبيق الفئات الفرعية لملف تعريف في طراز تقوم بتحريره, ومن ثم مشاركة الطراز مع أشخاص, يجب عليهم تثبيت ملف التعريف نفسه على أجهزة الكمبيوتر الخاصة بهم. وإلا، فلن يكون بإمكانهم مراجعة الفئات الفرعية التي قمت باستخدامها.

غالباً ما يكون ملف تعريف جزء من ملحق Visual Studio أكبر. على سبيل المثال، يمكنك تعريف أمر يترجم بعض الأجزاء من نموذج تعليمات برمجية. يمكنك تعريف ملف تعريف يجب على المستخدمين تطبيقه على الحزم التي يريدون ترجمتها. يمكنك توزيع الأمر الجديد و ملف التعريف الخاص بك في ملحق Visual Studio واحد.

يمكنك أيضاً تعريف المتغيرات المترجمة من ملف تعريف. المستخدمون الذين يقومون بتحميل الملحق الخاص بك يرون المتغير المناسب للبيانات الموروثة الخاصة بهم.

كيفية تعريف ملف تعريف

لتعريف ملف تعريف UML

1. أنشئ ملف XML جديد بامتداد ملف الاسم .profile.

2. أضف تعريفات فئة فرعية وفقاً للإرشادات المذكورة في بنية ملف التعريف.

3. أضف ملف التعريف إلى ملحق Visual Studio (ملف .vsix ). يمكنك إما إنشاء ملحق جديد لملف التعريف الخاص بك أو إضافة ملف التعريف إلى الملحق الموجود.

   راجع المقطع التالي كيفية إضافة ملف تعريف لملحق Visual Studio .

4. تثبيت الملحق على جهاز الكمبيوتر الخاص بك.

   1. انقر نقراً مزدوجاً فوق ملف الملحق الذي يحتوي على ملحق اسم الملف .vsix.

   2. أعد تشغيل Visual Studio.

5. للتحقق من أن ملف التعريف تم تثبيته, انقر فوق خاصية ملفات التعريف لأي حزمة أو طراز. ملف التعريف الخاص بك سوف يظهر في القائمة.

6. أرسل ملف الملحق للمستخدمين الآخرين لـ Visual Studio لتثبيته على أجهزة الكمبيوتر الخاصة بهم.

كيفية إضافة ملف تعريف إلى ملحق Visual Studio

لتثبيت ملف تعريف, و السماح لك بإرساله إلى مستخدمين آخرين, يجب عليك إضافة ملف التعريف إلى ملحق Visual Studio. لمزيد من المعلومات، راجع Deploying Visual Studio Extensions.

لتعريف ملف تعريف في ملحق Visual Studio جديد

1. أنشئ مشروع ملحق Visual Studio.

   ملاحظة

   يجب عليك أن تكون قد قمت بتثبيت عدة تطوير البرامج لـ Visual Studio لاستخدم هذا الإجراء.

   1. من القائمة File (ملف)، أشر إلى New (جديد)، ثم انقر فوق Project (مشروع).

   2. في مربع حوار مشروع جديد , ضِمن القوالب المثبتة، قم بتوسيع Visual C#‎ ، انقر فوق القابلية للتوسعةو ثم انقر فوق مشروع VSIX. عيّن اسم المشروع و انقر فوق موافق .

2. أضف ملف التعريف الخاص بك إلى المشروع.

   • في "مستكشف الحلول", انقر يمينا فوق المشروع، أشر إلى إضافة، ثم انقر فوق عنصر موجود. في مربع الحوار حدد موقع ملف التعريف الخاص بك.

3. عيّن خاصية ملف التعريف النسخ إلى إخراج .

   1. في مستكشف الحل انقر بزر الماوس الأيمن فوق ملف التعريف ثم انقر فوق خصائص.

   2. في نافذة "خصائص" قم بتعيين الخاصية النسخ إلى دليل إخراج إلى نسخ دوماً.

4. في "مستكشف الحلول", افتح source.extension.vsixmanifest.

   يتم فتح الملف في محرر ملف بيان الملحق.

5. عيّن حقول المعرِّف ID و اسم المنتَج. يجب أن يكون المعرِّف فريداً.

6. ضمن المحتوى ، عيّن صفّ يصف ملف التعريف:

   • انقر فوق إضافة محتوى . عيّن الحقول في الحوار إضافة محتوى كما يلي.

   • عيّن تحديد نوع محتوى إلى نوع ملحق مخصص

   • عيّن نوع إلى Microsoft.VisualStudio.UmlProfile

   • انقر فوق ملف في مشروع و حدد اسم ملف التعريف, على سبيل المثال MyProfile.profile

7. إنشاء المشروع.

8. في مستكشف Windows، افتح المجلد . \bin\Debug or . \bin\Release to find the .vsix file. هذا هو ملف ملحق Visual Studio . يمكن تثبيته على جهاز الكمبيوتر الخاص بك و إرساله لمستخدمي Visual Studio الآخرين.

9. لتثبيت الملحق:

   1. انقر نقرًا مزدوجًا فوق الملف .vsix. سيبدأ "مثبت ملحق Visual Studio".

   2. أعد تشغيل أية مثيلات من Visual Studio قيد التشغيل.

يمكن استخدام الإجراء البديل التالي للملحقات الصغيرة إذا لم تكن قد قمت بتثبيت عدة تطوير البرامج لـ Visual Studio.

لتعريف ملحق ملف تعريف دون استخدام Visual Studio SDK

1. أنشئ دليل Windows الذي يحتوي على الملفات الثلاثة التالية:

   • YourProfile.profile

   • extension.vsixmanifest

   • [Content_Types].xml-اكتب هذا الاسم كما هو موضح هنا، بالأقواس المربعة

2. حرر [Content_Types].xml ليحتوي على النص التالي. لاحظ أنه يحتوي على إدخال ملحق اسم ملف.

   <?xml version="1.0" encoding="utf-8"?>
   <Types xmlns="https://schemas.openxmlformats.org/package/2006/content-types">
     <Default Extension="profile" ContentType="application/octet-stream" />
     <Default Extension="vsixmanifest" ContentType="text/xml" />
   </Types>
   

3. انسخ extension.vsixmanifest موجود و قم بتحريره باستخدام محرر XML . غيّر عُقَد المُعرّف ، و الاسم ، و المحتويات.

   • يمكنك العثور على مثال extension.vsixmanifest في هذا الدليل:

     محرك الأقراص**:\Program Files\Microsoft Visual Studio 10.0\Common7\IDE\Extensions\Microsoft\Architecture Tools\UmlProfiles**

   • يجب أن تكون عقدة المحتوى مثل هذا:

     <Content>
       <CustomExtension Type="Microsoft.VisualStudio.UmlProfile"
       >YourProfile.Profile</CustomExtension>
     </Content>
     

4. اضغط الملفات الثلاثة في ملف من نوع ZIP.

   في "مكتشف Windows" ، حدد الملفات الثلاثة, انقر بزر الماوس الأيمن, أشر إلى إرسال إلى , ثم انقر فوق ملف مضغوط من نوع ZIP.

5. أعد تسمية الملف من نوع ZIP, ثم تغيير ملحق اسم الملف الخاص به من .zip إلى .vsix .

6. لتثبيت ملف التعريف على أي كمبيوتر بالإضافات المناسبة من إصدارات Visual Studio, انقر نقراً مزدوجاً فوق الملف .vsix .

لتثبيت ملف تعريف UML من ملحق Visual Studio

1. انقر نقراً مزدوجاً فوق الملف .vsix في مستكشف Windows , أو افتحه داخل Visual Studio.

2. في مربع الحوار الذي يظهر أمامك، انقر فوق تثبيت.

3. لإلغاء تثبيت أو تعطيل الملحق مؤقتًا, افتح مدير الملحقات من قائمة أدوات .

كيفية تعريف ملفات التعريف المترجمة

يمكنك تحديد ملفات تعريف مختلفة لثقافات أو لغات مختلفة, ثم حزمها في نفس الملحق. عند تحميل المستخدم للملحق الخاص بك ، سيلاحظ ملف التعريف الذي قمت بتعريفه للثقافة الخاصة بهم.

يجب عليك دوماً توفير ملف تعريف افتراضي. إذا لم تقم بتعريف ملف تعريف لثقافة المستخدم ، سيرى ملف التعريف الافتراضي.

لتعريف ملف تعريف مترجم

1. أنشئ ملف تعريف كما هو موصوف في المقاطع السابقة كيفية تعريف ملف تعريف و كيفية إضافة ملف تعريف ملحق Visual Studio . هذا هو ملف التعريف الافتراضي, و سيتم استخدامه في أي تثبيت لم تقم بتوفير ملف تعريف مترجم له.

2. أضف دليل جديد في نفس الدليل مثل ملف التعريف الافتراضي الخاص بك.

   ملاحظة

   إذا كنت تقوم بإنشاء الملحق باستخدام مشروع ملحق Visual Studio ,استخدام "مستكشف الحلول" لإضافة مجلد جديد إلى المشروع.

3. غيّر اسم الدليل الجديد إلى رمز ISO قصير للثقافة المترجمة مثل bg لـ البلغارية, أو fr للفرنسية. يجب عليك استخدام رمز ثقافة محايد, عادةً اثنين من الأحرف, و ليس ثقافة معينة مثل fr-CA. لمزيد من المعلومات حول رموز البيانات الموروثة راجع أسلوب CultureInfo.GetCultures ، الذي يوفر قائمة كاملة من رموز البيانات الموروثة.

4. أضف نسخة من ملف التعريف الافتراضي إلى الدليل الجديد. لا تقم بتغيير اسم الملف الخاص به.

   نموذج مجلد ملحق Visual Studio , قبل أن يتم إنشاؤه أو ضغطه في ملف .vsix ، سيحتوي على المجلدات والملفات التالية:

   extension.vsixmanifest

   MyProfile.profile

   fr\MyProfile.profile

   de\MyProfile.profile

   ملاحظة

   يجب ألا تدرج في extension.vsixmanifest مرجع إلى إصدارات مترجمة من ملفات التعريف. ملفات التعريف المنسوخة يجب أن يكون لها نفس الاسم مثل ملف التعريف في المجلد الأصل.

5. حرّر نسخة جديدة من ملف التعريف, و ترجمه إلى اللغة الهدف كافة الأجزاء التي ستكون مرئية للمستخدم, مثل سمات displayName .

6. يمكنك إنشاء مجلدات بيانات موروثة إضافية و ملفات تعريف مترجمة للعديد من الثقافات كما تريد.

7. أنشئ ملحق Visual Studio, إما عن طريق إنشاء "مشروع ملحق" أو ضغط كافة الملفات, كما هو موضح في المقاطع السابقة.

بنية ملف التعريف

هذا المقطع يستخدم ملف تعريف C# كمثال. التعريف المكتمل لملف التعريف يمكن رؤيته في

محرك الأقراص**:\Program Files\Microsoft Visual Studio 10.0\Common7\IDE\Extensions\Microsoft\Architecture Tools\UmlProfiles\CSharp.profile**

قد تختلف الأجزاء الأولى لهذا المسار في التثبيت الخاص بك.

للحصول على مزيد من المعلومات حول ملف تعريف ‎‎.NET راجع فئات الفرعية القياسية لطرازات UML

المقاطع الرئيسية لتعريف ملف تعريف UML

كل ملف تعريف يحتوي على المحتوى التالي:

<?xml version="1.0" encoding="utf-8"?>
<profile dslVersion="1.0.0.0" 
       name="CSharpProfile" displayName="C# Profile" 
       xmlns="https://schemas.microsoft.com/UML2.1.2/ProfileDefinition">
  <stereotypes>...</stereotypes>
  <metaclasses>...</metaclasses>
  <propertyTypes>...</propertyTypes>
</profile>

ملاحظة

السمة المسماة name يجب ألا تحتوي على مسافات أو علامات ترقيم. السمة displayName , و التي تظهر في واجهة المستخدم, يجب أن تكون سلسلة XML صالحة.

كل ملف تعريف يحتوي على ثلاثة مقاطع رئيسية. في ترتيب عكسي, هي كما يلي:

• <propertyTypes>-قائمة بالأنواع التي يتم استخدامها للخصائص المعرّفة في مقطه الفئات الفرعية.

• <metaclasses>-قائمة بأنواع عناصر الطراز التي يمكن تطبيق الفئات الفرعية عليها, مثل IClass, IInterface, IOperation, IDependency.

• <stereotypes> - تعريفات الفئات الفرعية. كل تعريف يتضمن الأسماء و الأنواع للخصائص التي تمت إضافتها إلى عنصر الطراز الهدف.

أنواع الخصائص

مقطع <propertyTypes> يقوم بتعريف قائمة بالأنواع التي يتم استخدامها من أجل الخصائص في المقطع <stereotypes> . هناك نوعان من أنواع الخصائص: خارجية و قائمة تعداد.

النوع الخارجي يقوم بتعريف الاسم المؤهل بشكل كامل لنوع .NET القياسي:

<externalType name="System.String" />

نوع التعداد يعرّف مجموعة من القيم الحرفية:

    <enumerationType name="PackageVisibility">
      <enumerationLiterals>
        <enumerationLiteral name="internal" displayName="internal"  />
        <enumerationLiteral name="protectedinternal" displayName="protected internal" />
      </enumerationLiterals>
    </enumerationType>

فئات التعريف

المقطع <metaclasses> هو قائمة بأنواع عناصر الطراز التي يمكن تعريف الفئات فرعية في ملف التعريف لها:

<metaclass 
      name="Microsoft.VisualStudio.Uml.Classes.IClass" />
<metaclass
      name="Microsoft.VisualStudio.Uml.Classes.IInterface" />
<metaclass
      name="Microsoft.VisualStudio.Uml.Components.IComponent" />

للحصول على قائمة كاملة من أنواع عناصر و علاقات الطراز التي يمكنك استخدامها كفئات تعريف ، أنواع عناصر الطراز.

تعريف الفئة الفرعية

المقطع <stereotypes> يحتوي على تعريف فئة فرعية واحد أو أكثر:

    <stereotype name="CSharpClass" displayName="C# Class">

كل فئة فرعية تسرد نوع عنصر أو علاقة طراز واحدة أو أكثر و التي يمكن أن يتم تطبيقها عليها. يمكنك إعطاء اسم نوع أساسي لتضمين كافة الأنواع المشتقة الخاص به. على سبيل المثال، إذا قمت بتحديد Microsoft.VisualStudio.Uml.Classes.IType ، الفئة الفرعي يمكن تطبيقها على IClass ، IInterface ، IEnumeration ، و عدة أنواع أخرى من العناصر.

      <metaclasses>
        <metaclassMoniker name=
         "/CSharpProfile/Microsoft.VisualStudio.Uml.Classes.IClass" />
      </metaclasses>

السمة name لـ metaclassMoniker هي ارتباط إلى عنصر في المقطع <metaClasses> .

ملاحظة

مسار الارتباط يجب أن يبدأ بـ /yourProfileName/ ، حيث yourProfileName معرف في السمة name لملف التعريف ("CSharpProfile" في هذا المثال). ينتهي مسار الارتباط باسم أحد الإدخالات في مقطع فئات التعريف.

كل فئة فرعية يمكنها سرد صفر أو أكثر من الخصائص التي التي تضيفها لأي عنصر طراز يتم تطبيقها عليه. <propertyType> تحتوي على ارتباط لواحد من الأنواع التي تم تعريفها في المقطع <propertyTypes> . يجب أن يكون الارتباط إما <externalTypeMoniker> ليشير إلى <externalType>, أو <enumerationTypeMoniker> ليشير إلى <enumerationType>. مجدداً، يبدأ الارتباط باسم ملف التعريف الخاص بك.

      <properties>
        <property name="IsStatic" 
                displayName="Is Static" defaultValue="false">
          <propertyType>
    <externalTypeMoniker 
                   name="/CSharpProfile/System.Boolean" />
          </propertyType>
        </property>
        <property name="PackageVisibility" 
                  displayName="Package Visibility"
                  defaultValue="internal">
          <propertyType>
            <enumerationTypeMoniker 
                  name="/CSharpProfile/PackageVisibility"/>
          </propertyType>
        </property>
      </properties>
    </stereotype>

أنواع عناصر الطراز

يتم سرد مجموعة من الأنواع يمكنك تعريف فئات فرعية لها في أنواع عناصر الطراز.

استكشاف الأخطاء وإصلاحها

• يظهر الخطأ التالي عند فتح أحد طرازات UML: VS1707: The following profiles cannot be loaded because a serialization error occurred: MyProfile.profile

  1. تحقق من أن بناء جملة XML الأساسي لـ .profile صحيح.

  2. تأكد من أن كل اسم لقب في شكل /profileName/nodeName . profileName هي قيمة سمة الاسم في عقدة جذر ملف التعريف. nodeName هي قيمة سمة اسم فئة التعريف أو externalType أو enumerationType.

  3. تأكد من بناء الجملة كما هو موصوف هنا, و كما هو موضّح في محرك الأقراص**:\Program Files\Microsoft Visual Studio 10.0\Common7\IDE\Extensions\Microsoft\Architecture Tools\UmlProfiles\** .

  4. أزل تركيب الملحق الخطأ. من القائمة "أدوات"، انقر فوق "مدير الملحقات".

     • إذا لم يظهر الملحق, راجع العنصر التالي.

  5. أعد إنشاء الملف VSIX و افتحه في "مستكشف Windows" لإعادة تثبيته. أعد تشغيل Visual Studio.

• الملحق غير ظاهر في ملحق إدارة، ولكن عندما حاولت إلى قم بإعادة يثّبت، تظهر الرسالة التالية: The extension is already installed to all applicable products.

  1. أزل ملف الملحق من المجلد الفرعي \Microsoft\VisualStudio\10.0\Extensions\ LocalAppData

     • لمراجعة LocalAppData ، يجب تعيين "إظهار الملفات والمجلدات المخفية" في علامة التبويب "عرض" في "خيارات مجلد مستكشف Windows".

     • LocalAppData يكون عادة في C:\Users\userName\AppDat

  2. أعد تشغيل Visual Studio.

راجع أيضًا:

المهام

كيفية القيام بما يلي: إضافة فئات فرعية إلى عناصر طراز

المبادئ

فئات الفرعية القياسية لطرازات UML

موارد أخرى

تخصيص الطراز الخاص بك بملفات التعريف و الفئات