Запитання з тегом «javadoc»

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

96 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 (чи можливо це взагалі?)? І якщо це можливо, як я можу …

92 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 

Я розробляю API з багатьма методами з однаковою назвою, які просто відрізняються підписом, що, на мою думку, досить поширене. Всі вони роблять те саме, за винятком того, що вони ініціалізують різні значення за замовчуванням, якщо користувач не хоче вказувати. Як засвоюваний приклад, розглянемо public interface Forest { public Tree addTree(); …

82 java  javadoc 

Вибачте за ймовірне запитання типу FAQ, але я просто не можу знайти відповідь. Наскільки я пам’ятаю Eclipse, порожній рядок у коментарі Javadoc відображається (у спливаючих вікнах Javadoc) як розрив рядка (з додатковим вертикальним інтервалом). Однак у Netbeans це не так. Чи можу я налаштувати Javadoc на інтерпретацію порожнього рядка як …

81 java  netbeans  comments  javadoc 

На даний момент існує два способи позначити код як застарілий у Java. Через JavaDoc /** * @deprecated */ Або як анотацію: @Deprecated Це моя проблема - я вважаю, що занадто багато оголошувати обидва, позначаючи метод як застарілий під час використання Eclipse. Я дуже хочу просто використати один із них. Однак …

81 java  annotations  javadoc  deprecated 

Я хотів би, щоб коментарі 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-time-2.0-dist.zip/download ) У eclipse [проект правою кнопкою миші -> Властивості -> Шлях побудови Java -> Бібліотеки -> ДОДАТИ JAR …

80 java  eclipse  jar  javadoc 

Зачинено. Це питання не відповідає вимогам щодо переповнення стека . Наразі відповіді не приймаються. Хочете покращити це питання? Оновіть питання, щоб воно було тематичним для переповнення стека. Закрито 6 років тому . Удосконалюйте це питання Погодьмося: вам не потрібно бути дизайнером, щоб побачити, що Javadoc за замовчуванням виглядає потворно . …

80 java  documentation  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