У меня есть большая база кода без Javadoc, и я хочу запустить программу для записи скелета с базовой информацией Javadoc (например, для каждого параметра метода write @param...), поэтому мне просто нужно заполнить пробелы влево.
Кто-нибудь знает хорошее решение для этого?
Edit:
JAutodoc - это то, что я искал. Он имеет Ant задачи, плагин Eclipse и использует Velocity для определения шаблона.
JAutodoc плагин для eclipse делает именно то, что вам нужно, но с гранулярностью пакета:
щелкните правой кнопкой мыши на пакете, выберите "Добавить javadoc для участников...", и скелет будет добавлен.
Существует множество интересных вариантов: шаблоны для javadoc, добавление TODO в заголовке каждого файла, в котором говорится: "шаблон javadoc, должен быть заполнен..." и т.д.
Я думаю, что автогенерация пустого Javadoc является анти-шаблоном и должна быть обескуражена; он придает коду внешний вид документирования, но просто добавляет шум в кодовую базу.
Вместо этого я бы рекомендовал вам настроить редактор кода, чтобы помочь на основе каждого метода и каждого класса использовать, когда вы действительно пишете javadoc (один комментатор указал на функцию Eclipse, которая делает это).
Вы также можете поместить курсор на строку над методом, который вы хотите использовать для JavaDoc, затем введите:
/**
и нажмите Enter. Это приведет к созданию заглушки JavaDoc.
Вы можете настроить eclipse, чтобы отображать предупреждения для вещей, которые не имеют javadoc, или имеют javadoc, который не имеет всей информации, или имеет неправильную информацию. Он также может вставлять шаблоны для заполнения.
Не тот инструмент, который вы просили, но, вероятно, лучше, потому что вы не получите пустых скелетов по методам, которые вы пропустили.
Это можно сделать, исследуя и редактируя страницу предпочтений за пределами пути Window > Preferences > Java > Compiler > Javadoc для вашей рабочей области. Снимок экрана этой страницы предпочтений ниже:
Для получения дополнительной информации о товарах на этом экране, пожалуйста, перейдите по ссылке ниже:
Если вы щелкните правой кнопкой мыши по источнику файла в Eclipse, у него есть опция генерации Javadoc в исходном меню.
Выберите метод, который вы хотите добавить 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;
}