هل يمكنني استخدام GhostDoc لإضافة وثائق إلى فئة كاملة أو ملف رمز؟

Question

أحب Ghostdoc، لكنني أريد أن أكون قادرا على "توثيق" هذا "للحصول على ملف كامل، وليس عضوا واحدا فقط في وقت واحد. هل هذا ممكن؟

Answer 1

لا، ما زلت أحبها أيضا بغض النظر.

Answer 2

عندما أجبت في الأصل هذا السؤال، لم يكن ذلك ممكنا في ghostdoc، أو في addin (مماثلة)، الوثائق Atomineer Pro).

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

لكن, ، كل من الإضافات الآن توفر الآن هذه الميزة، وهي مفيدة للغاية في المواقف التالية:

• (في Atomineer) إلى الدفعات الإرث البديلة بين جافادوك، Doxygen، QT وتنسيقات مستندات XML
• (في Atomineer) لتحديث Style / تخطيط تعليقات الوثائق بعد تغيير خيارات تنسيق AtomineTrutils
• (في كل من الأدوار) لإضافة وثائق هيكل عظمي بسرعة إلى فئة

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

Answer 3

استخدام خيار ملف المستند:

اختر خيار ملف المستند

انظر التعليق أضيف لجميع الأعضاء داخل الملف