Генератор шаблонов Javadoc
У меня большая кодовая база без Javadoc, и я хочу запустить программу для написания скелета с базовой информацией Javadoc (например, для каждого параметра метода напишите @param ...), поэтому мне просто нужно заполнить оставшиеся пробелы.
Кто-нибудь знает хорошее решение для этого?
Редактировать:
JAutodoc - это то, что я искал. Он имеет задачи Ant, плагин Eclipse и использует Velocity для определения шаблона.
Ответы 6
Если щелкнуть правой кнопкой мыши источник файла в Eclipse, в меню «Источник» появится опция создания документации Javadoc.
Не знаю - это всегда было для меня :(
Для меня это Источник -> Создать комментарий к элементу.
Я тоже этого не вижу. У вас должен быть установлен плагин. Какой пакет Eclipse вы скачали?
Плагин JAutodoc для eclipse делает именно то, что вам нужно, но с детализацией пакета:
Щелкните правой кнопкой мыши пакет, выберите «Добавить javadoc для участников ...», и скелет будет добавлен.
Есть множество интересных опций: шаблоны для javadoc, добавление TODO в заголовок каждого файла со словами: «шаблон javadoc, должен быть заполнен ...» и т. д.
Я прочитал документацию к этому плагину. Он предлагает очень автоматизированные способы добавления комментариев JavaDoc к вашим методам, переменным, параметрам и т. д. Но если вы не отредактируете автоматически сгенерированные комментарии, чтобы сделать их «лучше поясняющими», это не более чем много строк в вашем тексте. код...
Вы можете настроить eclipse для отображения предупреждений о вещах, в которых отсутствует javadoc, или есть javadoc, который не содержит всей информации или содержит неверную информацию. Он также может вставлять шаблоны для заполнения.
Не совсем тот инструмент, который вы просили, но, вероятно, лучше, потому что у вас не останется пустых скелетов для методов, которые вы пропустили.
Вы можете добиться этого, изучив и отредактировав страницу настроек за пределами пути Window> Preferences> Java> Compiler> Javadoc для вашей рабочей области. Снимок экрана этой страницы предпочтений приведен ниже:
Для получения дополнительной информации об элементах на этом экране перейдите по ссылке ниже:
Справка по настройкам Javadoc для компилятора Java
Вы забыли упомянуть, как это включено. Как получить эту функцию?
Добавлен скриншот и дополнительная информация.
Я считаю, что автоматическое создание пустого документа Javadoc - это анти-шаблон, и его не следует поощрять; он придает коду вид, что он задокументирован, но лишь добавляет шума в кодовую базу.
Вместо этого я бы порекомендовал вам настроить свой редактор кода, чтобы он помогал на основе каждого метода и класса использовать, когда вы фактически пишете javadoc (один комментатор указал на функцию Eclipse, которая делает это).
Не могли бы вы объяснить, как настроить что-то для каждого метода и класса, как вы упомянули?
Здесь люди указывают, что это особенность Eclipse. Я кодирую (ed) Java с помощью vim, который довольно легко настраивается - вы просто создаете макрос, который при использовании имени метода или класса добавляет шаблон Javadoc для заполнения. Однако, честно говоря, набирать косую черту и звездочку нельзя. действительно узкое место в написании хорошей документации
Вы также можете поместить курсор в строку над методом, который вы хотите использовать в JavaDoc, а затем ввести:
/**
и нажмите Enter. Это сгенерирует вашу заглушку JavaDoc.
На Mac это ⌘-alt-J
Выберите метод, который вы хотите добавить 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;
}
Я не вижу его в исходном меню, есть ли параметр, который мне не хватает?