В Eclipse я могу нажать Alt+ Shift+ Jи получить автоматически генерируемый комментарий javadoc с полями, возвратами или чем-то еще, что будет применимо для этого конкретного комментария javadoc. Я предполагаю, что IntelliJ IDEA имеет эту функцию. Может кто-нибудь сказать мне, есть ли сочетание...
Закрыто. Этот вопрос не соответствует рекомендациям по переполнению стека . В настоящее время он не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы он соответствовал теме Stack Overflow. Закрыт 3 года назад . Уточните этот вопрос есть хороший пример исходного файла,...
Какое соглашение вы используете для комментирования геттеров и сеттеров? Вот то, что я задумывался довольно давно, например: /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * @return (2b) */ public...
Мне не нравятся Javadocs по умолчанию, сгенерированные для меня, когда я создаю класс или методы, особенно переменную @author, которая является текущим системным именем пользователя в моем окне Windows. Я хотел бы это изменить. Это...
Используя Javadoc 1.5, мне не удалось создать ссылку @ на значение перечисления. Я хотел бы создать такой Enum: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** * Others we know nothing about. */...
Если я пишу <xmlElement>в javadoc, он не отображается, потому что теги имеют специальные функции по форматированию текста. Как я могу показать эти символы в
Когда я кодирую в Netbeans, он автоматически заполняет код и показывает Javadocs. Однако, когда я использую Intellij IDEA, если я нажимаю Ctrl+,Space я вижу автозаполнение, а если я нажимаю Ctrl+,Q я вижу javadoc отдельно. Можно ли увидеть Javadoc элемента всякий раз, когда я вижу автозаполнение...
При создании нового класса или интерфейса в IDE Netbeans появляется тег «@author ....». Как изменить его значение? Если возможно, я хотел бы изменить его, используя меню Netbeans, а не редактируя некоторые файлы конфигурации :) Я использую Netbeans...
Когда использовать @seeпри работе с JavaDocs? Каково его использование? Например , если MethodAвызовы , MethodBто я должен поставить @seeв MethodBJavadoc «s и ссылки , MethodAпотому что это то , что называется, или я должен поставить ссылку на MethodBиз , MethodAпотому что звонит его. Я читал...
Правильно ли добавлять комментарии Javadoc в интерфейс и добавлять комментарии не Javadoc в реализацию? Большинство IDE генерируют комментарии, отличные от 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 with...
Я перехожу с Eclipse на Intellij Idea. Одна вещь, которую я пока не мог понять, - это автозаполнение @authorтега JavaDoc. При вводе @aв Eclipse есть два предложения: @author - author name @author Как мне добиться первого предложения в Intellij (возможно ли это вообще?)? И если возможно, как мне...
Я часто сталкиваюсь с дилеммой при написании javadoc для свойств / членов "простого" класса POJO, содержащего только свойства, геттеры и сеттеры (стиль DTO) .... 1) Напишите javadoc для свойства или ... 2) Напишите javadoc для получателя Если я напишу javadoc для свойства, моя IDE (Eclipse)...
Предположим, что в рамках документирования вашего кода (Javadoc) вы хотите указать, что отношения между элементами используют глубокие отступы. Как я могу создать вложенный список как: какой-то элемент какой-то другой элемент еще какой-то элемент...
Я просмотрел ссылку на JavaDoc , и, хотя я понимаю основную разницу между @see(различными ссылками) и {@inheritDoc}(экспортом комментария JavaDoc суперкласса), мне нужно пояснить, как это реализовано на самом деле. В Eclipse IDE, когда я выбираю «Создать комментарии к элементам» для...
Я пишу javadoc для класса, который содержит собственные перечисления. Есть ли способ создать javadoc для отдельных перечислений? Например, сейчас у меня что-то вроде этого: /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; Однако это только...
Извините за возможный вопрос типа FAQ, но я просто не могу найти ответ. Насколько я помню, Eclipse, пустая строка в комментарии Javadoc отображается (во всплывающих окнах Javadoc в исходном коде) как разрыв строки (с дополнительным вертикальным интервалом). Однако в Netbeans это не так. Могу ли я...
В настоящее время работаю с JavaFX. Всякий раз, когда я наводил курсор на метод JavaFX, он выдает следующую ошибку: 'Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found' Как мне решить эту проблему? Как я могу прикрепить javadoc или исходный код,...
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 (как...
Как можно документировать параметры записи Java ? Я имею в виду параметры, которые в конечном итоге становятся параметрами конструктора, полями классов. Я старался: /** * @param name the name of the animal * @param age the age of the animal */ public record Animal(String name, int age) { } но...