يمكن للمرء إنشاء علامات Javadoc تلقائيا لمشروع Eclipse بأكمله؟

Question

أعرف أن المرء يمكنه استخدام "u003Calt>u003Cshift> J 'لإنشاء علامات لعنصر رمز واحد (طريقة الفصل على سبيل المثال).

ولكن هل هناك طريقة لإنشاء هذه العلامات تلقائيا لكل فئة في المشروع بأكمله؟ أو حتى فقط في حزمة أو مستوى الفصل؟

Answer 1

هل نظرت في jautodoc.?

Answer 2

ليس هذا ما أعلمه عن.

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

Answer 3

إن Javadoc الناتج التلقائي هو ألم، لأن الأشخاص الآخرين أبدا الآن ما يجب أن تفعله الطريقة وسوف تعرفها أيضا، عندما تنظر إلى الفصل بعد سنة واحدة.

يرجى التعليق على أساليبك بنفسك أو لا تعلق الطريقة.

تستخدم شركتي CheckStyle لإجبار أصحاب العمل على إضافة Javadoc. يكره بعض أصحاب العمل أن يعلقون أساليبهم ونوع تعليقات لا معنى لها. سيكون من الأفضل أن لا يوجد تعليق من عديمة الفائدة.

باستخدام CheckStyle، يمكنك العثور على جميع الأساليب غير الموثقة، لتوثيقها بتنسيق جيد.

ماذا سيساعدك على توثيق طريقة INIT

"يجب أن يتم استدعاء INIT قبل أي طريقة أخرى وتهيئة ActionDummy"

من الأفضل أن تخبر ما يتم بالضبط

قم بتنفيذ الحالة الافتراضية لمزود الإجراءات. يمكن تجاوز بعض متغيرات الدولة من قبل المستمع عند ....