Programowanie javadoc

1

Jak mogę odwołać się do wartości końcowego pola statycznego w klasie?

Jak za pomocą JavaDoc mogę odwołać się do wartości końcowego pola statycznego w klasie? Chcę, aby ???w tym przykładzie zastąpiono wartością pola STATIC_FIELD. /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the …

99 java documentation javadoc

4

Jak napisać Javadoc właściwości?

Często napotykam dylemat, pisząc javadoc dla właściwości / elementów „prostej” klasy POJO zawierającej tylko właściwości oraz metody pobierające i ustawiające (w stylu DTO) .... 1) Napisz javadoc dla właściwości lub ... 2) Napisz javadoc dla metody pobierającej Jeśli napiszę javadoc dla tej właściwości, moje IDE (Eclipse) (naturalnie) nie będzie w …

93 java javadoc

4

Autouzupełnianie @author w Intellij

Migracja z Eclipse do Intellij Idea. Jedną rzeczą, której nie mogłem jeszcze zrozumieć, jest autouzupełnianie @authortagu JavaDoc. Pisząc @aw Eclipse, mamy dwie propozycje: @author - author name @author Jak uzyskać pierwszą propozycję w Intellij (czy to w ogóle możliwe?)? A jeśli to możliwe, jak zmienić szablon tego, co jest wstawiane …

93 intellij-idea javadoc

3

Jak utworzyć wiele poziomów wcięć w Javadoc?

Załóżmy, że w ramach dokumentowania kodu (Javadoc) chcesz wskazać relacje między elementami za pomocą głębokich wcięć. Jak mogę utworzyć zagnieżdżoną listę jako: jakiś element jakiś inny element jeszcze jakiś inny element

88 documentation javadoc indentation nested-lists

1

Szczegóły różnicy między @see i @inheritDoc

Przejrzałem odniesienie do JavaDoc i chociaż rozumiem podstawową różnicę między @see(różnymi linkami) a {@inheritDoc}(eksport komentarza JavaDoc nadklasy), potrzebuję wyjaśnienia, jak rzeczy faktycznie zostały zaimplementowane. W środowisku Eclipse IDE, kiedy wybiorę opcję „Generuj komentarze elementu” dla metody dziedziczonej (z interfejsu lub zastąpienia toString () itd.), Tworzy następujący komentarz /* (non-Javadoc) * …

87 java javadoc comments

2

Jak wykonać Javadoc indywidualne wyliczenia klasy

Piszę javadoc dla klasy, która zawiera własne wyliczenia. Czy istnieje sposób na wygenerowanie javadoc dla poszczególnych wyliczeń? Na przykład w tej chwili mam coś takiego: /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; Jednak to tylko dokumentuje wszystkie wyliczenia jako całość: …

84 java enums javadoc

4

Ponowne użycie Javadoc dla przeciążonych metod

Tworzę API z wieloma identycznie nazwanymi metodami, które różnią się tylko podpisem, co, jak sądzę, jest dość powszechne. Wszystkie robią to samo, z wyjątkiem tego, że domyślnie inicjują różne wartości, jeśli użytkownik nie chce ich określać. Jako przystępny przykład rozważ public interface Forest { public Tree addTree(); public Tree addTree(int …

82 java javadoc

7

Javadoc: podziały wierszy bez tagów HTML?

Przepraszam za prawdopodobne pytanie typu FAQ, ale po prostu nie mogę znaleźć odpowiedzi. O ile pamiętam Eclipse, pusty wiersz w komentarzu Javadoc jest wyświetlany (w wyskakujących okienkach Javadoc w źródle) jako podział wiersza (z dodatkowymi odstępami w pionie). Jednak w Netbeans tak nie jest. Czy mogę skonfigurować Javadoc, aby interpretował …

81 java netbeans comments javadoc

5

Eclipse, jak połączyć jar zawierający javadocs / source z jego plikiem binarnym?

Chciałbym, aby komentarze javadoc zawarte w pliku jar były wyświetlane w zaćmieniu, gdy najeżdżam kursorem na klasę. Przykładowo po pobraniu JODA-2.0 uzyskujemy trzy słoiki: joda-time-2.0 joda-time-2.0-javadoc joda-time-2.0-sources ( http://sourceforge.net/projects/joda-time/files/joda-time/2.0/joda-time-2.0-dist.zip/download ) W eclipse, [projekt kliknięcia prawym przyciskiem myszy -> Właściwości -> Ścieżka budowania Java -> Biblioteki -> DODAJ pliki JAR ...] …

80 java eclipse jar javadoc

12

Czy istnieją dobre i nowoczesne alternatywy dla Javadoc? [Zamknięte]

Zamknięte. To pytanie nie spełnia wytycznych dotyczących przepełnienia stosu . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby było na temat przepełnienia stosu. Zamknięte 6 lat temu . Popraw to pytanie Spójrzmy prawdzie w oczy: nie musisz być projektantem, aby zobaczyć, że domyślny Javadoc wygląda brzydko . …

80 java documentation javadoc

13

Jak dołączyć źródło lub JavaDoc w eclipse dla dowolnego pliku jar, np. JavaFX?

Obecnie pracuję z JavaFX. Za każdym razem, gdy najeżdżam kursorem na metodę JavaFX, pojawia się następujący błąd: 'Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found' Jak mam to rozwiązać? Jak mogę dołączyć javadoc lub źródło, aby zobaczyć opis metod?

79 java eclipse javadoc javafx-2

3

JDK 11+ i 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. Czy ktoś był w stanie sprawić, że javadoc działa bez konieczności zmiany wersji źródłowej na 1.8 (jak sugerowano na innych forach)? Używam JDK …

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

1

Jak udokumentować parametry Java Record?

Jak należy udokumentować parametry Java Record ? Mam na myśli parametry, które ostatecznie stają się parametrami konstruktora, polami klas. Próbowałem: /** * @param name the name of the animal * @param age the age of the animal */ public record Animal(String name, int age) { } ale flagi IntelliJ IDEA …

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

Pytania otagowane jako javadoc