Eclipse ułatwia korzystanie z javadoc-u. Aby wygenerować szkielet komentarza, należy:
- Wpisać ciąg znaków: „*/**”,
- Umieścić kursor w linijce z nagłówkiem klasy/ metody/ zmiennej, którą chcemy skomentować. Z menu kontekstowego wybrać Source->Add javadoc comment, lub nacisnąć Shift+Alt+J.
Np. dla metod zostanie wygenerowany komentarz zawierający odpowiednie wpisy:
- @param,
- @returns,
- @throws.
Szkielet komentarzu można modyfikować w preferencjach Eclipse'a: menu Window->Preferences->Java->Code Style->Code Templates.
Aby wygenerować dokumentacje należy wybrać: menu Project -> Generate Javadoc. Można tam określić dla jakich pakietów, czy klas chcemy wygenerować dokumentacje, albo jakie tagi uwzględnić.
Brak komentarzy:
Prześlij komentarz