2011-09-11 14 views
17

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?

+3

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

+0

Zdałem sobie z tego sprawę, ale lepiej późno, że nigdy :) –

Odpowiedz

29

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.

+4

+1; auto-generowanie dokumentów dla * wszystkiego * jest ekstremalnie nieproduktywne ze względu na nadmierny hałas. –

+1

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ź. –

+0

"ustawia wartość" typu komentarzy faktycznie pogarsza czytelność kodu. –

7

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.

+0

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

5

Aby dodać komentarz nad metodą wybrać getUser lub wziąć kursor przed getUser i naciśnij ALT + SHIFT + J It doda komentarz do twojej metody:

/* 
* @param 
* @return User 
*/ 
public User getUser(); 
+0

To doda komentarz klasy, prawda? – hirosht

+0

@hirosht tak, to jest – David

0

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.

0

Mac użytkowników: ^ - - J

  • Opcja - ⌥
  • sterowania -^

Okna użytkowników: Przesunięcie - Alt - J

PS: Upewnij się, że masz zainstalowany plugin JAutodoc

2

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

Powiązane problemy