Javadoc to rozszerzalny system generowania dokumentacji, który czyta specjalnie sformatowane komentarze w kodzie źródłowym Java i generuje skompilowaną dokumentację. Zwykle jest używany do tworzenia dokumentacji API w postaci stron internetowych HTML.
Napisałem komentarze w stylu Javadoc, takie jak ten w kodzie mojego projektu: /** * Description... * * @param ... * @return ..... */ Jak mogę generować pliki Javadoc HTML za pomocą Eclipse IDE?
Przeglądałem dokumentację javadoc w witrynie Sun, próbując znaleźć znacznik javadoc, który może być użyty do udokumentowania ogólnego podpisu typu klasy lub metody. Coś podobnego @typeparam, podobnego do zwykłego @param, ale pasującego do typów i metod, np /** * @typeparam T This describes my type parameter */ class MyClass<T> { } …
Zamknięte . To pytanie jest oparte na opiniach . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby można było na nie odpowiedzieć, podając fakty i cytaty, edytując ten post . Zamknięte 2 lata temu . Popraw to pytanie Obecnie zaczynam od Pythona i mam solidne podstawy PHP, …
Niedawno przeniosłem się z Eclipse do Android Studio i podoba mi się to. Brakuje mi jednak funkcji Javadoc on hover od Eclipse. Postępowałem zgodnie z instrukcjami tutaj, aby dodać funkcjonalność, jednak moje dymki nie zawierają Javadoc. Jeśli użyję skrótu do dokumentacji Ctrl+ Shift+ Space, dokumentacja zostanie wyświetlona poprawnie, jednak naprawdę …
Chcę zmienić automatycznego autora, który pojawia się, gdy tworzę plik w AndroidStudio. /** * Created by a556520 on 16/01/14. */ public class POI { Autor bierze numer „a556520”, ale chcę, aby było wyświetlane moje imię i nazwisko, a nie numer pracownika. Czy to jest możliwe? Nie znalazłem w ustawieniach.
W Eclipse mogę nacisnąć Alt+ Shift+ Ji otrzymać komentarz javadoc generowany automatycznie z polami, zwrotami lub cokolwiek innego, co miałoby zastosowanie do tego konkretnego komentarza javadoc. Zakładam, że IntelliJ IDEA ma tę funkcję. Czy ktoś może mi powiedzieć, czy istnieje do tego skrót klawiaturowy?
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 czy istnieje dobry przykład pliku źródłowego zawierającego Javadoc ? Mogę znaleźć wiele dobrych przykładów Javadoc w …
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 …
Nie podoba mi się domyślne Javadoc generowane dla mnie podczas tworzenia klasy lub metod, zwłaszcza zmienna @author, która jest bieżącą nazwą użytkownika systemu w moim oknie Windows. Chciałbym to zmienić. czy to możliwe?
Jeśli piszę <xmlElement>w javadoc, to się nie pojawia, ponieważ tagi mają specjalne funkcje w formatowaniu tekstów. Jak mogę pokazać te znaki w 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, …
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 Ctrl+Space w Intellij IDEA, tak jak Netbeans?
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 7.2
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 informacje @seena stronie Oracle i wydaje mi się, że są one …
Czy poprawną praktyką jest dodawanie komentarzy Javadoc w interfejsie i dodawanie komentarzy innych niż Javadoc w implementacji? Większość IDE generuje komentarze inne niż JavaDoc dla implementacji, gdy automatycznie generujesz komentarze. Czy konkretna metoda nie powinna mieć opisu?
Używamy plików cookie i innych technologii śledzenia w celu poprawy komfortu przeglądania naszej witryny, aby wyświetlać spersonalizowane treści i ukierunkowane reklamy, analizować ruch w naszej witrynie, i zrozumieć, skąd pochodzą nasi goście.
Kontynuując, wyrażasz zgodę na korzystanie z plików cookie i innych technologii śledzenia oraz potwierdzasz, że masz co najmniej 16 lat lub zgodę rodzica lub opiekuna.