Pytania oznaczone «javadoc»

140
dobry przykład Javadoc [zamknięty]

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 3 lata temu . Popraw to pytanie...

125
Proste komentarze Getter / Setter

Jakiej konwencji używasz do komentowania metod pobierających i ustawiających? To jest coś, nad czym zastanawiałem się od jakiegoś czasu, na przykład: /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put...

121
Jak @link do wartości wyliczenia przy użyciu Javadoc

Używając Javadoc 1.5, nie mogłem utworzyć @link do wartości wyliczenia. To, co chciałbym zrobić, to utworzyć wyliczenie w następujący sposób: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** *...

120
Intellij IDEA automatycznie wyświetla javadoc

Kiedy piszę w Netbeans, automatycznie uzupełnia kod i wyświetla Javadocs. Jednak gdy używam Intellij IDEA, jeśli kliknę Ctrl+Space , widzę autouzupełnianie, a jeśli kliknę Ctrl+Q , mogę osobno zobaczyć javadoc. Czy można zobaczyć Javadoc elementu, gdy widzę autouzupełnianie lub kliknięcie...

113
Netbeans: jak zmienić @author

Podczas tworzenia nowej klasy lub interfejsu w Netbeans IDE pojawia się znacznik „@author…”. Jak zmienić jego wartość? Jeśli to możliwe, chciałbym to zmienić używając menu Netbeans a nie edytując jakieś pliki konfiguracyjne :) Używam Netbeans

110
Wykorzystanie @see w JavaDoc?

Kiedy mam do @seeczynienia z JavaDocs? Jakie jest jego zastosowanie? Na przykład, jeśli MethodArozmowy MethodBpotem muszę umieścić @seew MethodB„s javadoc i odniesienia MethodAponieważ to, co się nazywa, czy muszę umieścić odniesienie do MethodBz MethodA, ponieważ jest to powołanie. Przeczytałem...

93
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,...

93
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...

87
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...

84
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...

82
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...

81
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...