كيف يمكنني المحافظة على التعليقات XML أوصاف الأسلوب في ملف منفصل؟

Question

وهذا السؤال ينبع من هذا السؤال كم هو أكثر من اللازم؟

وكانت

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

وكان الجواب لاستخدام التضمين العلامة

/// <include file="Documentation/XML/YourClass.xml" path="//documentation/members[@name='YourClass']/*"/>

وهناك أيضا المادة MSDN حول التضمين العلامة هنا.

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

Answer 1

والجواب بسيط. قراءة ملفات XML المنتجة. أنها تعطي فكرة عن مدى ملفات XML المنفصلة يجب أن تبدو.

وقراءة ملفات XML المنتجة وكيف الطريقة الموصوفة (مع المعلمات وكذا):

<member name="M:BitFactory.Logging.Logger.DoLog(BitFactory.Logging.LogEntry)">
    <summary>
    Really log aLogEntry. (We are past filtering at this point.)
    Subclasses might want to do something more interesting and override this method.
    </summary>
    <param name="aLogEntry">The LogEntry to log</param>
    <returns>true upon success, false upon failure.</returns>
</member>

وT، M، F نوع البادئات، الطريقة، الميدان.