javadoc
правильно ли добавлять комментарии Javadoc в интерфейс и добавлять комментарии, отличные от Javadoc, в реализацию? большинство IDE генерируют комментарии без JavaDoc для реализаций при автоматическом создании комментариев. Разве конкретный метод не должен иметь описание?...
Я хотел бы, чтобы комментарии javadoc, содержащиеся в файле jar, отображались в eclipse при наведении курсора на класс. например, после загрузки JODA-2.0 получается три банки: joda-time-2.0 joda-time-2.0-javadoc joda-time-2.0-источники (http://sourceforge.net/projects/joda-time/files/joda-time/2.0/joda-tim...
Я посмотрел ссылка JavaDoc и хотя я понимаю, основное различие между @see (разные ссылки) и {@inheritDoc} (экспорт суперкласса JavaDoc комментарий), Мне нужно пояснение о том, как вещи на самом деле реализованы. в Eclipse IDE, когда я выбираю "Generate Element Comments" для унаследованного метода (из интерф...
Я разрабатываю API со многими одинаково названными методами, которые просто отличаются подписью, что, я думаю, довольно распространено. Все они делают одно и то же, за исключением того, что они инициализируют различные значения по умолчанию, если пользователь не хочет указывать. В качестве удобоваримого приме...
Я пишу javadoc для класса, который содержит его собственный перечислений. Есть ли способ создать javadoc для отдельных перечислений? Например, прямо сейчас у меня есть что-то вроде этого: /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; однако это то...
этот вопрос уже есть ответ здесь: Java Javadoc include Private 2 ответы как я могу сделать ссылку javadoc на частное поле? class Foo { private String bar; public String getBar() { return bar; } } {@link Foo#get...
мне интересно о лучших практиках при создании Javadocs. У меня есть проект со многими файлами. Код был создан многими разработчиками. Каждый файл имеет аннотацию @author, поэтому очевидно, кто создал тот или иной класс. но когда какой-нибудь другой разработчик добавляет новый код в файл, изменяет его, и т. ...
в OpenJDK, для метода: public static Double valueOf(double d) javadoc говорит: возвращает двойной экземпляр, представляющий указанное двойное значение. Если новый экземпляр Double не требуется, этот метод обычно следует использовать в предпочтении к конструктору Double (double), так как этот метод, вер...
когда я использую быстрый поиск documentaion (Ctrl+Q) на классах j2ee или аннотациях в IDEA, я получаю только пустой javadoc. Он содержит только основы, такие как имя класса. Как добавить javadoc в идею libs, которая сама себя обеспечивает?...
каковы наилучшие обходные пути при запуске javadoc с помощью JDK 8 и один получает эту ошибку. похоже, что для JDK 8 было решено, что теги вроде <br /> и <p /> должны генерировать ошибки, потому что они являются недопустимыми (строгими) HTML 4. смотрите список рассылки обсуждения JDK здесь интер...