يعرض تعريف GOTO التعليقات التعليقات ، هل تم إنشاؤها من تعليقات XML؟

Question

لقد فوجئت بشكل معتدل مؤخرًا لاكتشاف أن تعليقاتي XML المصممة بعناية لم تكن تظهر في Intellisense لزملائي. بعد استخدام التجميعات المرتبطة به دائمًا مع مراجع المشروع ، لم أكن أدرك أنه كان عليك تصدير مستند .xml وكذلك للوصول إلى هذه المعلومات.

هذا دفعني إلى التساؤل كيف يعمل .NET Framework Intellisense. إذا فهمت بشكل صحيح ، يجب إخفاء ملفات .xml في مكان ما في مجلد خاص؟

لكن سؤالي الرئيسي هو حول "تعريف goto" - إذا كنت goto تعريف على مجموعة إطار عمل .NET ، يمكنك الحصول على المعلومات التي تم إنشاؤها من البيانات الوصفية - ولكن أيضًا مع الكثير من التعليقات المفيدة - هل يتم إنشاؤها سحريًا من تعليقات XML ، أو هل قام شخص ما لكتابة ماكرو + لتحويله فقط للبناء؟ وضعه بشكل مختلف: كيف يمكنني الحصول على هذا التأثير على تجميعاتي؟

Answer 1

هل تم تكوين مشاريعك لإنشاء وثائق XML؟ لمجرد أنك تضيف التعليقات إلى الكود المصدري ، فلن يقوم المترجم بإنشاء ملف .xml ما لم يتم إخباره بذلك.

في صفحة خصائص المشروع ، انتقل إلى علامة التبويب "بناء" وانظر إلى قسم "الإخراج". يجب أن ترى إدخال مربع الاختيار بعنوان "ملف توثيق XML". إذا كان مربع Textwer بعد خانة الاختيار فارغة ، فلن تقوم بإنشاء ملف وثائق XML.

بمجرد الحصول على ملف توثيق XML الذي تم إنشاؤه ، يجب أن ترى تعليقاتك في تلميحات الأدوات Intellisense. إذا قمت بتضمين إشارات إلى مشاريع أخرى كمرجع للمشروع ، فيجب أن يحدث ذلك تلقائيًا. إذا قمت بتضمين إشارات إلى التجميعات ، فأنت بحاجة إلى التأكد من أن ملف XML في نفس موقع التجميع المشار إليه. (عند الإنشاء ، يجب أن تحصل على ملفات XML لجميع التجميعات التي تحتوي عليها في مجلد BIN/Debug أو Bin/Release على التوالي.)

بالنسبة لتجميعات .NET Framework نفسها ، يتم تثبيت ملفات وثائق XML المقابلة كجزء من الإطار. لـ .NET 2.0 أو 3.0 أو 3.5 توجد ملفات الوثائق في C:\Windows\Microsoft.NET\Framework\v2.0.50727\en (بافتراض التثبيت الافتراضي للإطار). يتم استخدام هذه الملفات من قبل كل من Toolsense Toolsips ووظيفة "GO to Definition" في Visual Studio من أجل عرض هذه المعلومات. لا توجد أي معالجة خاصة تحدث أو يتم تشغيل وحدات الماكرو من أجل تحقيق ذلك. المعلومات الوحيدة التي تستخدمها Visual Studio على الأرجح هي مزيج من مفاتيح التسجيل لتحديد المسار الصحيح لملفات الوثائق.

على الرغم من أنك ربما يمكنك تحديد موقع ملفات توثيق XML لمجموعاتك الخاصة في نفس المجلد ، إلا أنني أوصي بعدم القيام بذلك أثناء تلوث التثبيت الإطاري بملفات ذات صلة غير برمجة.