مولد قالب Javadoc [مغلق]

https://stackoverflow.com/questions/29689

09-06-2019
|

سؤال

لدي قاعدة تعليمات برمجية كبيرة بدون Javadoc، وأريد تشغيل برنامج لكتابة هيكل أساسي يحتوي على معلومات Javadoc الأساسية (على سبيل المثال، اكتب @param...)، لكل معلمة طريقة، لذلك عليّ فقط ملء الفجوات المتبقية.

هل يعرف أحد حلاً جيدًا لهذا؟

يحرر:

JAutodoc هو ما كنت أبحث عنه.يحتوي على مهام Ant، ومكون إضافي لـ Eclipse، ويستخدم السرعة لتعريف القالب.

المحلول

ال JAutodoc يقوم المكون الإضافي لـ Eclipse بتنفيذ ما تحتاجه بالضبط، ولكن مع تفاصيل الحزمة:

انقر بزر الماوس الأيمن على الحزمة، وحدد "إضافة javadoc للأعضاء..." وسيتم إضافة الهيكل العظمي.

هناك العديد من الخيارات المثيرة للاهتمام:قوالب javadoc، مع إضافة TODO في رأس كل ملف يقول:"يجب ملء قالب javadoc..."، وما إلى ذلك.

نصائح أخرى

أعتقد أن إنشاء Javadoc الفارغ تلقائيًا هو نمط مضاد ويجب تثبيطه؛فهو يعطي الكود مظهرًا وكأنه موثق، ولكنه يضيف فقط ضوضاء إلى قاعدة التعليمات البرمجية.

أوصي بدلاً من ذلك بتكوين محرر التعليمات البرمجية الخاص بك للمساعدة على أساس كل طريقة وكل فئة لاستخدامه عند كتابة javadoc فعليًا (أشار أحد المعلقين إلى ميزة Eclipse التي تقوم بذلك).

يمكنك أيضًا وضع المؤشر على السطر الموجود أعلى الطريقة التي تريدها لـ JavaDoc، ثم اكتب:

/**

واضغط على Enter.سيؤدي هذا إلى إنشاء كعب JavaDoc الخاص بك.

يمكنك تكوين Eclipse لإظهار تحذيرات للأشياء التي تفتقر إلى javadoc، أو التي تحتوي على javadoc لا تحتوي على كافة المعلومات، أو تحتوي على معلومات خاطئة.يمكنه أيضًا إدراج قوالب لتعبئتها.

ليست الأداة التي طلبتها تمامًا، ولكن ربما تكون أفضل لأنك لن ينتهي بك الأمر بهياكل عظمية فارغة للطرق التي فاتتك.

يمكنك تحقيق ذلك من خلال فحص صفحة التفضيلات وتحريرها خارج المسار Window > Preferences > Java > Compiler > Javadoc لمساحة العمل الخاصة بك.لقطة الشاشة لصفحة التفضيل هذه موجودة أدناه:

The so-called Javadoc preference page

لمزيد من المعلومات حول العناصر الموجودة في هذه الشاشة، يرجى اتباع الرابط أدناه:

تعليمات تفضيلات Javadoc لمترجم Java

حدد الطريقة التي تريد إضافة Javadoc و بديل+يحول+ي, ، يقوم تلقائيًا بإنشاء تعليق javadoc.

مثال:

/**
     * @param currDate
     * @param index
     * @return
     */
    public static String getAtoBinary(String currDate, int index){  
        String HourA = "0";
        try{
            String[] mydate = currDate.split("/");
            HourA = mydate[index].substring(1, 2);
        }catch(Exception e){
            Log.e(TAG, e.getMessage());
        }
        return HourA;
    }

إذا قمت بالنقر بزر الماوس الأيمن فوق مصدر الملف في Eclipse، فسيكون لديه خيار إنشاء Javadoc ضمن القائمة المصدر.

مرخصة بموجب: CC-BY-SA مع الإسناد

لا تنتمي إلى StackOverflow