Вопросы с тегом «javadoc»

Как с помощью JavaDoc ссылаться на значение последнего статического поля в классе? Я хочу, чтобы ???в этом примере заменили значение поля STATIC_FIELD. /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the value …

100 java  documentation  javadoc 

Я часто сталкиваюсь с дилеммой при написании javadoc для свойств / членов "простого" класса POJO, содержащего только свойства, геттеры и сеттеры (стиль DTO) .... 1) Напишите javadoc для свойства или ... 2) Напишите javadoc для получателя Если я напишу javadoc для свойства, моя IDE (Eclipse) (естественно) не сможет отобразить это, …

93 java  javadoc 

Я перехожу с Eclipse на Intellij Idea. Одна вещь, которую я пока не мог понять, - это автозаполнение @authorтега JavaDoc. При вводе @aв Eclipse есть два предложения: @author - author name @author Как мне добиться первого предложения в Intellij (возможно ли это вообще?)? И если возможно, как мне изменить шаблон …

93 intellij-idea  javadoc 

Предположим, что в рамках документирования вашего кода (Javadoc) вы хотите указать, что отношения между элементами используют глубокие отступы. Как я могу создать вложенный список как: какой-то элемент какой-то другой элемент еще какой-то элемент

88 documentation  javadoc  indentation  nested-lists 

Я просмотрел ссылку на JavaDoc , и, хотя я понимаю основную разницу между @see(различными ссылками) и {@inheritDoc}(экспортом комментария JavaDoc суперкласса), мне нужно пояснить, как это реализовано на самом деле. В Eclipse IDE, когда я выбираю «Создать комментарии к элементам» для унаследованного метода (из интерфейса или переопределения toString () и т. …

87 java  javadoc  comments 

Я пишу javadoc для класса, который содержит собственные перечисления. Есть ли способ создать javadoc для отдельных перечислений? Например, сейчас у меня что-то вроде этого: /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; Однако это только документирует все перечисления в целом: Есть …

84 java  enums  javadoc 

Извините за возможный вопрос типа FAQ, но я просто не могу найти ответ. Насколько я помню, Eclipse, пустая строка в комментарии Javadoc отображается (во всплывающих окнах Javadoc в исходном коде) как разрыв строки (с дополнительным вертикальным интервалом). Однако в Netbeans это не так. Могу ли я настроить Javadoc на интерпретацию …

81 java  netbeans  comments  javadoc 

В настоящее время работаю с JavaFX. Всякий раз, когда я наводил курсор на метод JavaFX, он выдает следующую ошибку: 'Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found' Как мне решить эту проблему? Как я могу прикрепить javadoc или исходный код, чтобы …

79 java  eclipse  javadoc  javafx-2 

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. Кто-нибудь смог заставить работать javadoc без необходимости менять исходную версию на 1.8 (как предлагалось на других форумах)? Я использую JDK v11.0.5, и проблема …

13 java  maven  javadoc  java-11  maven-javadoc-plugin 

Как можно документировать параметры записи Java ? Я имею в виду параметры, которые в конечном итоге становятся параметрами конструктора, полями классов. Я старался: /** * @param name the name of the animal * @param age the age of the animal */ public record Animal(String name, int age) { } но …

12 java  intellij-idea  javadoc  java-14  java-record