Генератор шаблонов Javadoc [закрыт]

StackOverflow https://stackoverflow.com/questions/29689

  •  09-06-2019
  •  | 
  •  

Вопрос

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

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

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

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

Это было полезно?

Решение

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

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

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

Другие советы

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

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

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

/**

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

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

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

Этого можно добиться, изучив и отредактировав страницу настроек за пределами пути «Окно» > «Настройки» > «Java» > «Компилятор» > «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
scroll top