.صافي XML التعليق في وثائق API

Question

هل هناك طريقة سهلة لإنتاج MSDN على غرار الوثائق من Visual Studio XML الإخراج ؟
أنا لست مريض بما فيه الكفاية على xslt على ذلك لأنني أعرف أنني لست أول شخص عبر هذا الجسر.

كما حاولت وضع الرمال في الآونة الأخيرة, ولكن جعلت حقا بلدي عيون الصليب.سواء كنت في عداد المفقودين شيء مهم في عملية أو أنها مجرد مشاركة جدا.

أنا أعرف أن هناك شخص ما لديه حقا لطيفة ميتا حل بسيط.

أنا التأكيد هنا لأنني أعتقد أن التنسيق جعلت تلك الفقرة غير دعوة للقراءة:

أعطى الرمال المحاولة ولكن كان الوقت الصعب حقا الحصول على اقامة.حقا ما يدور في ذهني هو شيء أبسط من ذلك بكثير.

إلا إذا أنا فقط لا أفهم الرمال عملية.يبدو مثل الكثير من الأمتعة الإضافية لي فقط أن تنتج شيئا جميلا اختبار للعمل مع.

Answer 1

كنت تبحث عن الرمال

صفحة المشروع: Sandcastle النشرات

بلوق: Sandcastle بلوق

NDoc وثائق التعليمات البرمجية مولد .صافي اعتادت أن تكون أداة الاختيار ، ولكن الدعم قد توقف.

Answer 2

إلقاء نظرة على الرمال, الذي يفعل ذلك بالضبط.كما أنها واحدة من أكثر أبسط الحلول هناك, و هو أكثر أو أقل أداة الاختيار ، لذلك على المدى الطويل ربما نحن يمكن أن تساعدك على إعداد الرمال إذا قمت بتحديد ما هي القضايا التي واجهتها أثناء الإعداد ؟

Answer 3

يجب عليك أيضا استخدام الرمال تساعد على ملف البناء.فإنه يوفر لك مع ndoc مثل واجهة المستخدم الرسومية لتوليد ملفات المساعدة لذلك لم يكن لديك لفعل أي شيء من موجه الأوامر.

مرحبا بكم في الرمال تساعد الملف منشئ المشروع

Answer 4

اتبع هذا بسيط الخطوة 5 من المادة و أنت فعلت الكثير جدا.على سبيل المكافأة يمكنك استخدام H2Viewer لعرض تعليمات Html 2.× الملفات.

Answer 5

لقد إعداد الرمال مرة أخرى.حاول تثبيت ذلك (أيار / مايو 2008 الإصدار) و البحث عن SandcastleGui.exe أو شيئا من هذا القبيل (إنه في الأمثلة مجلد أو نحو ذلك).

انقر فوق إضافة الجمعية وإضافة الجمعية أو الجمعيات ، أي إضافة .ملفات وثائق xml (تلك التي تم إنشاؤها بواسطة برنامج التحويل البرمجي إذا قمت بتمكين هذا الخيار) ومن ثم بناء.

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

Sandcastle يبدو معقدا في البداية ، وخصوصا عندما كنت ترغب في استخدامه في بناء الآلي, ولكن أنا متأكد تماما أنه سوف يكون يستحق كل هذا الجهد.

يكون أيضا نظرة على Sandcastle ملف المساعدة باني, هذا هو إلى حد ما أكثر تقدما واجهة المستخدم الرسومية لذلك.

Answer 6

يمكنني استخدام NDoc3