C++ XML التعليقات لتوليد MSDN نمط آلية غرفة تبادل المعلومات [مغلقة]
-
21-08-2019 - |
سؤال
لدي عدة مشاريع بعض باستخدام التعليمات البرمجية المدارة وبعض فقط باستخدام المدارة.جميع XML تتم إضافة التعليقات و وثائق XML يتم إنشاء بشكل صحيح (إنشاء ملف xml و المتوسطة في xdc الملفات).
بالتأكيد هناك شيء يمكن أن تأخذ هذه الملفات (إخراج xdcmake) وتوليد MSDN نمط chm مساعدة!?من ما أفهم ، سواء doxygen و الرمال تجاهل واضح أن خطوة إعادة اختراع العجلة إلى إعادة فحص للتعليمات البرمجية الخاصة بك.(هناك أيضا حقيقة أن الرمال هو على ما يبدو عديم الفائدة بالنسبة non-.NET المشاريع).
بعد أن حاول doxygen (الرهيبة الإخراج ، ولكن بسرعة) و الرمال (لطيفة MSDN نمط الانتاج ، ولكن عن وجوههن في الطريق) كل من تسول أن يتفوق عليها شيء أبسط من ذلك بكثير.
أيضا سيكون من الرائع إذا كان هناك نوع من محرر المرتبطة أننا يمكن أيضا كتابة "الابتداء" و "المعلومات" نوع من الصفحات التي هي أيضا في حاجة مع أي وثائق API.
لا أحد يعرف من أي حلول ؟
المحلول
وقد ترغب في محاولة DoxyComment . هنا هو وصف من في Doxygen أدوات مساعد ومخطوطات :
<اقتباس فقرة>وهناك الدين ل Visual Studio 2005 طالب تم إنشاء DoxyComment بواسطة اللاعب Troels غرام. وهي مصممة لمساعدتك في إدخال سياق تعليق حساسة كتل إلى C الملفات المصدر / C ++. كما يأتي DoxyComment مع XSLT القالب الذي يتيح لك توليد الوثائق مثل مكتبة MSDN.
اقتباس فقرة>نصائح أخرى
وبصراحة، القلعة الرملية هو أفضل رهان. وأنا أعلم أنه يمكن أن يكون شيئا من الألم لتكوين، ولكن وثائق هو بالضبط النمط الذي تبحث عنه.
أعلم المشروع حيث الناس لا تزال تستخدم NDocConsole
ومع ذلك أعتقد أن NDoc هو مشروع ميت, لأن في http://ndoc.sourceforge.net/ لا توجد تحديثات منذ عام 2005