Czy można łatwo dodać blok komentarza (styl Javadoc) do każdej metody w projekcie Eclipse i ewentualnie do zajęć, aby móc je później wypełnić?Jak dodać blok komentarza do metod w Eclipse?
Odpowiedz
Zgodnie z sugestią możesz to zrobić metoda-na-metoda (Źródło -> Wygeneruj komentarz elementu) lub ALT+SHIFT+J
, ale uważam to za bardzo zły pomysł. Komentarze są przydatne tylko wtedy, gdy dają dodatkowe informacje. Kiedy potrzebujesz więcej informacji, dodaj to.
Po dodaniu komentarzy do ustawiaczy takich jak "ustawia wartość" lub gorzej automatycznie generuje komentarze, które nie są w ogóle użyteczne.
+1; auto-generowanie dokumentów dla * wszystkiego * jest ekstremalnie nieproduktywne ze względu na nadmierny hałas. –
Ta metoda dodaje bloki komentarzy do zmiennych i metod klasy. Jednak po prostu dodaje normalne/* */do każdej metody bez żadnych innych szczegółów. Pamiętam używanie programu do dodawania komentarza w stylu PHPdoc do każdej funkcji w projektach PHP z wieloma szczegółami. W każdym razie, dzięki za odpowiedź. –
"ustawia wartość" typu komentarzy faktycznie pogarsza czytelność kodu. –
Pod
oknie | Preferencje | Java | Styl kodu | Szablony Kod
znajdziesz 2 funkcje:
- Automatyczne dodawanie komentarzy do nowych metod lub typów
- komentarzy | Metody | Edytuj ...
Możesz edytować wygenerowany blok komentarza za pomocą zmiennych zaćmieniowych lub statycznego tekstu Javadoc.
W jaki sposób mogę zastosować komentarz metody do kodu źródłowego? Na przykład w (Źródło -> Wygeneruj komentarz elementu), możemy wygenerować, aby powiedzieć komentarz klasy, czy istnieje jakiś szybki sposób, w jaki moglibyśmy "Wygenerować komentarz do metody". – user454083
Może szukasz tego
wykonaj następujące kroki, a zrobisz to z łatwością. w Zaćmienie przejdź do Projekt -> generuj javadoc -> naciśnij enter, a następnie wybierz swój projekt do udokumentowania.
Mac użytkowników: ^ - ⌥ - J
- Opcja - ⌥
- sterowania -^
Okna użytkowników: Przesunięcie - Alt - J
PS: Upewnij się, że masz zainstalowany plugin JAutodoc
prostą rzeczą jest, wystarczy wpisać/**, a następnie naciśnij Enterna górze metody, w której chcesz wygenerować komentarz .it automatycznie generuje element komentarz. Nie trzeba długo szukać.
- 1. Automatycznie "kontynuuj" blok komentarza w Sublime po naciśnięciu Enter?
- 2. Jak mogę dodać komentarza do pliku YAML w Pythonie
- 3. eclipse wyłącza uzupełnianie komentarza xml
- 4. Jak dodać bibliotekę do Eclipse?
- 5. Dodawanie komentarza do przestarzałej metody
- 6. Pisanie komentarza w Eclipse łączącego konkretną linię
- 7. Skrót Eclipse do zaznaczenia komentarza w pliku XML
- 8. Formatowanie Eclipse dodaje spację do pustych wierszy komentarza.
- 9. Jak dodać blok cdata za pomocą GDataXMLNode?
- 10. Jak dodać istniejące pliki/foldery do Eclipse
- 11. Jak dodać serwer GlassFish do Eclipse Oxygen?
- 12. Automatyczne generowanie komentarza do metody w XCode
- 13. Jak dodać metod klasy wygoda do klasy Singleton w Ruby
- 14. ng-include kompiluje do komentarza
- 15. Jak zapobiec formatowi klang, aby dodać spację po znaku komentarza?
- 16. Jak dodać serwer JBoss w środowisku Eclipse?
- 17. Jak dodać parametry do wszystkich metod żądań HttpClient?
- 18. Jak dodać projekt Spark do Mavena w Eclipse?
- 19. Dodawanie komentarza do pola podczas tworzenia tabeli?
- 20. dodać obsługę Java Eclipse
- 21. „blok ostatecznie nie zakończy normalnie” Eclipse ostrzeżenie
- 22. Eclipse - Czy można połączyć z plikiem z poziomu komentarza Java?
- 23. Pośrednio dodać metod do prototypu konstruktora w JavaScript
- 24. dodać # * # glob do .gitignore?
- 25. Jak uzyskać listę metod w Eclipse bez dziedziczenia (skrót)?
- 26. Eclipse - jak określić liczbę metod w aplikacji Java
- 27. Jak zmienić metodę Ruby w blok?
- 28. Jak mogę dodać zewnętrzny słoik do aplikacji eclipse rcp?
- 29. Jak dodać drugi katalog źródłowy do projektu Eclipse
- 30. Jak dodać różne języki programowania do Eclipse (C++, C#, Java)
Tak, można kliknąć prawym przyciskiem myszy na metodę declaraion, a następnie kliknąć "Source> Generate Element comment'. Mimo to nie warto dodawać dokumentacji później ... to nigdy nie działa. Dokumentuj każdą metodę przed jej wdrożeniem lub przynajmniej natychmiast po jej wdrożeniu! – home
Zdałem sobie z tego sprawę, ale lepiej późno, że nigdy :) –