Sandcastle - لا يزال الشيء الصحيح للاستخدام؟ أم هل هناك بدائل؟ [مغلق
https://stackoverflow.com/questions/986741
-
13-09-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russianسؤال
أنا فقط أتساءل - الإصدار الأخير من sandcastle. هو من مايو 2008، وما زال مدرج كبرنامج مسبق للإصدار / CTP ولم يعد مرخصا حتى الآن، كما يقول EULA على وجه التحديد:
2.TM. مدة هذه الاتفاقية هي حتى 1 سبتمبر 2007، أو الإفراج التجاري عن البرنامج، أيهما هو الأول.
نظرا لأن Sandcastle هو "ثقيل" على أي حال، أتساءل فقط عما إذا كان لا يزال الأمر الصحيح للاستخدام، أو إذا كان هناك بدائل لإنشاء وثائق XMLDOC؟ (البدائل = شيء يمكنني تشغيله من البنية الخاصة بي لتوليد HTML على الأقل، ويفضل PDF أيضا).
المحلول
لم يذكر أحد DOCU، مشروع مؤخرا بدأه جيمس غريغوري، الرصاص Dev على FluentniBernate.
إنها أداة بسيطة وسهلة الاستخدام تولد وثائق HTML A LA RDoc. وبعد يمكنك تعديل القوالب بسهولة نظرا لاستخدام Docu شرارة كمحرك عرض.
هنا هو وثائق fluentnibernate. بنيت مع docu.
نصائح أخرى
مايكروسوفت ساندكاسل لا تزال بالتأكيد الطريقة الصحيحة للذهاب. البديل الرئيسي (الذي يقدم أي شيء بالقرب من مجموعة ميزة Sandcastle) هو NDOC, ، ولكن الإصدار الأخير من ذلك أكبر بكثير، يجري في يناير 2005!
على الرغم من أنه لا يزال من الناحية الفنية في مرحلة ما قبل الإصدار (متأخرا)، فهو في الواقع أداة مستقرة تماما. تم إصلاح عدد قليل من الأخطاء بواسطة بقع، متوفرة على Codeplex كجزء من أنماط الرمل مشروع. هناك أيضا واجهة المستخدم الرسومية رائعة لذلك، أي Sandcastle مساعدة ملف باني.
لست متأكدا من التنمية المستقبلية للرملية ولكن. أعتقد أنه من المحتمل أن تواصل Microsoft العمل / التوسع عليه في مرحلة ما، على الرغم من أنه لا يبدو أن هناك أي أخبار متى. إنها بالتأكيد الأداة اللائقة الوحيدة لإنشاء وثائق مناسبة لمكتبة أو تطبيق .NET، في الوقت الحالي. بالطبع، يمكنك في كثير من الأحيان الابتعاد باستخدام أدوات "الوزن خفيف الوزن" لمشاريع / ملفات تعليمات صغيرة. البدائل الرئيسية التي لاحظتها أنها تجارية وأكون أقل من الرمل.
من المحتمل أن تكون توثيق توليد الوثائق باليد / استخدام الأتمتة المخصصة ممكنا في حالات معينة، ولكن فقط للمشاريع الصغيرة (من غير المرجح أن تتوسع.)
بقدر ما أعرف، لا يزال Sandcastle خيارا صالحا. لقد استخدمتها عدة مرات في الماضي القريب وليس لها أي مشاكل. يمكنك التحقق من هذه الصفحة على MSDN وانتقل لأسفل إلى قسم "الوثائق" للحصول على خيارات جيدة أخرى:
لاستخدام Sandcastle بشكل فعال، كما أشار Noldorin في وقت سابق، وكذلك استخدام Sandcastle Styles و Sandcastle Help File Builder (SHFB). لديهم جميعا إصدار جديد في منتصف عام 2010، وبالتأكيد الأدوات الحالية.
حتى مع وجود واجهة المستخدم الرسومية النظيفة والبسيطة المقدمة من SHFB، ومع ذلك، هناك عدد كبير من القضايا التي قد تحتاجها أو تريد مراعاتها من أجل إنتاج مجموعة وثائق مرتبة ومهنية. مقالتي ("ترويض Sandcastle: دليل مبرمج .NET لتوثيق الكود الخاص بك") توثيق تجربتي مع مجموعة متنوعة من المزالق المحتمل، المنشورة simple-talk.com. في سبتمبر 2010، قد ينقذ أنت بعض الوقت، الجهد، والمعاناة :-).
مورد آخر مفيد: في أكتوبر 2010 تابعت المقال مع جدول جدار واحد التي تلخص توثيق XML تعليق معجم ل SHFB.
docproject. يستحق إلقاء نظرة على. يستغرق الكثير من آلام العمل مع Sandcastle.
وضعت قائمة قصيرة من بعض أدوات الوثائق في هذا السؤالأي شخص يستخدم NDOC-OR-A- أداة مماثلة
أعتقد أن Sandcastle هي أفضل أداة OpenSource (توثيق مشاريع .NET)، ولكن هناك العديد من الأدوات التجارية، ويمكنها أن تقترح أداء أفضل وأكثر من الميزات، لذلك إذا كان لديك ميزانية واحدة منها، فإنها تستحق تقييمها على الأقل ما القيمة التي يمكن أن تحضرها لك.
