2013-07-12 9 views
17

mam pewne metody:Jak skonfigurować szablony javadoc Intellij Idea?

public int getSomeField() 

Chcę, aby wygenerować javadoc tak:

/** 
* Gets {someField} 
* 
* @return value of {someField} 
*/ 

Gdzie {someField} jest symbolem zastępczym dla nazwy pola. Możliwe jest stworzenie tych szablonów dla Intellij Idea (może to być szablon na żywo)?

+0

Jeśli uzywasz Eclipse Polecam [JAutoDoc] (http://jautodoc.sourceforge.net/). – mattbdean

Odpowiedz

5

Generujesz Javadoc, umieszczając wskaźnik nad metodą. Następnie wpisz /** i naciśnij Wpisz.

Niestety szablon nie może być zmieniony i nie ma na to zapytanie: http://youtrack.jetbrains.net/issue/IDEA-28206

+0

Połączony problem jest oznaczony jako "naprawiony" teraz – Gallal

+0

Możesz teraz edytować komentarze do szablonów. Zobacz odpowiedź poniżej. http://stackoverflow.com/a/38094408/2377639 –

6

Zapewni to większość drogi.

File | Settings... | Live Templates

Naciśnij zielony oraz dodać nowy szablon niestandardowy.

Abbrevation: text getter

Szablon:

/** 
* Gets $FIELD$ 
* 
* @return value of $FIELD$ 
*/ 
public $RET$ get$FIELD$() 
{ 
    $END$ 
} 

Obowiązujące w Javie: declaration.

Wpisz getter gdzie można wykonać metodę i tab kompletną.

Jedynym mankamentem jest to, że nie wiem, jak zrobić pierwszą literę $FIELD$ skapitalizowaną w get$FIELD$, ale żadną z innych lokalizacji.

Oto obraz dla odniesienia:

IntelliJ Template "getter"

0

Próbowałem methodName() wyrażenie, ale to działa tylko podczas wewnątrz metody, chcesz metodę poza nim, w javadoc.

13

przywołać menu Generate (Cmd + N na Mac, Alt + Insert Windows)

Generate menu

Kliknij wielokropka w prawym górnym rogu.

Generate Getters menu

Kliknij plusa w lewym górnym rogu i utworzyć nowy szablon. Create new template dialog

Skopiuj zawartość starego szablonu do nowego szablonu i dodaj następujące linie na górze.

/** 
* Gets $field.name 
* 
* @return value of $field.name 
*/ 

enter image description here

Teraz podczas generowania użycia getter „nowego szablonu” i powinieneś otrzymać getter z JavaDoc.

Select New Template

enter image description here

+0

Działa jak urok: D – Dr4gon