Генератор шаблона документации

Плагин JAutodoc для eclipse делает именно то, что вам нужно, но с детализацией пакета :

щелкните правой кнопкой мыши на пакете, выберите "Add javadoc for members...", и скелет будет добавлен.

Есть множество интересных опций: шаблоны для javadoc, добавление TODO в заголовке каждого файла со словами: "шаблон javadoc, должен быть заполнен...", прием.

Я думаю, что автоматическое создание пустого Javadoc является анти-шаблоном и должно быть обескуражено; это дает коду видимость документирования, но просто добавляет шум в кодовую базу.

Я бы рекомендовал вместо этого настроить редактор кода, чтобы он помогал на основе каждого метода и класса использовать его при написании javadoc (один комментатор указал на функцию Eclipse, которая делает это).

Вы также можете поместить курсор на строку над методом, который вы хотели бы JavaDoc, а затем ввести:

/**

и нажмите Enter. Это создаст ваш заглушка JavaDoc.

Вы можете настроить eclipse для отображения предупреждений для вещей, которые не имеют javadoc, или имеют javadoc, который не имеет всей информации, или имеет неправильную информацию. Он также может вставлять шаблоны для заполнения.

Не совсем тот инструмент, который вы просили, но, вероятно, лучше, потому что вы не будете в конечном итоге с пустыми скелетами на методах, которые вы пропустили.

Вы можете добиться этого, исследуя и редактируя страницу предпочтений за пределами окна путь > настройки > Java > компилятор > Javadoc для вашего рабочего пространства. Скриншот этой страницы предпочтений приведен ниже:

Для получения дополнительной информации об элементах на этом экране, пожалуйста, перейдите по ссылке ниже:

Java Предпочтения Документации Компилятора Помочь

Выберите метод , который вы хотите добавить Javadoc и alt + Shift + j , автоматически создает комментарий javadoc.

EXAMPLE:

/**
     * @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 в меню Источник.