كيفية استخدام ملفات وثائق XML

Question

1. عند استخدام تجميع خارجي يأتي مع ملف وثائق XML، كيف يمكنني الحصول على الاستوديو المرئي للعثور عليه؟

2. عند وجود ملف وثائق XML، هل يوجد برنامج أو ملف تحويل XML أو أي شيء يمكنني استخدامه للنظر إليه بطريقة لطيفة؟ليس بالضرورة معقدًا مثل عارض وثائق msdn، ولكنه على الأقل شيء أجمل من XML النقي ...

Answer 1

1:يمكنك ببساطة إسقاطه في نفس المجلد مثل ملف dll

2:هل من الضروري أن تستمر؟بالنسبة للاستخدام "المباشر"، يسمح لك كل من VS IDE و"العاكس" بمراجعة الوثائق (مقابل الأنواع/الأعضاء/إلخ).هناك أدوات لتحويله، لكنني لم أزعجني أبدًا. قلعة الرمل قد يكون الأمر يستحق المشاهدة، لكنه لم يكن لطيفًا بالنسبة لي أبدًا؛-p

Answer 2

بخصوص 2:يجب أن تكون قادرًا على إلقاء نظرة على "إصدار جميل" من الوثائق باستخدام متصفح الكائنات (عرض > متصفح الكائنات (Ctrl W + J)) ثم تصفح طريقك إلى الفصل الذي تريد مراجعة الوثائق من أجله.لقد استخدمت Object Browser لمراجعة المستندات الخاصة بي نظرًا لأنها أكثر سهولة في القراءة من ملفات xml أو التعليقات.

Answer 3

الإجابة على سؤالك الأول:يجب أن يحمل ملف XML نفس اسم التجميع وأن يكون بجواره مباشرةً.لذلك، إذا كان لديك تجميع يسمى Svish.dll، فيجب أن يكون ملف الوثائق الخاص بك هو Svish.xml وأن يكون في نفس الدليل.

Answer 4

1) يجب أن يكون لملف التوثيق نفس اسم اسم التجميع، مع الامتداد المضاف '.xml'، وأن يكون موجودًا في نفس الدليل مثل التجميع المقابل له.على سبيل المثال، لديك ملف "MyCompany.MyNamespace.dll" وملف "MyCompany.MyNamespace.dll.xml" في نفس الدليل.

2) NDOC يمكن أن تولد بعض تنسيقات ديرنت من الوثائق.