Генератор шаблона Javadoc

голоса
32

У меня есть большой кодовую без Javadoc, и я хочу, чтобы запустить программу, чтобы написать скелет с основной информацией Javadoc (например, для записи параметров @param каждого метода ...), так что я просто должны заполнить пробелы, оставленные.

Кто-нибудь знает хорошее решение для этого?

Редактировать:

JAutodoc является то, что я искал. Он имеет Ant задачи, плагин для Eclipse и использует Velocity для определения шаблона.

Задан 27/08/2008 в 08:55
источник пользователем
На других языках...                            


6 ответов

голоса
38

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

щелкните правой кнопкой мыши на пакете, выберите «Добавить документацию для членов ...» и скелет будет добавлен.

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

Ответил 28/08/2008 d 11:02
источник пользователем

голоса
22

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

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

Ответил 15/09/2008 d 17:35
источник пользователем

голоса
10

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

/**

и нажмите Enter. Это позволит сгенерировать JavaDoc окурок.

Ответил 09/05/2013 d 23:37
источник пользователем

голоса
4

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

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

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

Так называемые страницы предпочтения Javadoc

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

Java Compiler Javadoc Настройки Справка

Ответил 28/08/2008 d 11:06
источник пользователем

голоса
2

Выберите метод , который вы хотите добавить Javadoc и alt+ Shift+ j, автоматически создает 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;
    }
Ответил 28/08/2014 d 22:32
источник пользователем

голоса
2

Если щелкнуть правой кнопкой мыши в источнике файла в Eclipse, он имеет опцию генерации Javadoc под меню источника.

Ответил 27/08/2008 d 09:05
источник пользователем

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more