Jak zmienić szablon Javadocs wygenerowany w Eclipse?

123

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?

java eclipse templates javadoc Olaseni
źródło
2
Aby @authordostosować zmienną, możesz ustawić niestandardowy ciąg, edytując eclipse.iniplik i dodając plik -Duser.name=customstring(testowane w Kepler / Luna )
KrishPrabakar,
3
Lepiej pozbądź się @authortagu, ponieważ jest to niechciany dźwięk .
Alexander Pozdneev,

Odpowiedzi:

188

Czek Preferences / Java / Code Style / Code Template

Sekcja Comment / Type

Możesz zamienić authortag na dowolną potrzebną wartość i będzie to miało wpływ na nowo generowane klasy.

Szablony kodu

Jeśli jednak szablon jest w porządku, ale wartość, do której odwołuje się kup znacznik autora, nie jest, zobacz to pytanie SO :

${user}używa wartości user.namezmiennej środowiskowej; w związku z tym, można przejść -Duser.name=My Namew eclipse.iniaby go zastąpić.

Lub, jeśli wolisz, możesz zmodyfikować skrót, aby wskazywał:

C:/java/eclipse/eclipse.exe -vmargs -Duser.name="cleverUserNameToUseInSourceCode"
  • MacOs: Aram Kocharyan wspomina, że eclipse.inijest w, Eclipse.app/Contents/MacOS/jeśli klikniesz prawym przyciskiem myszy i wybierzesz Pokaż zawartość pakietu.
  • ZendStudio: rofflox komentuje, że plik ma nazwę ZendStudio.inii znajduje się w Applications/Zend Studio.app/Contents/MacOS/.
VonC
źródło
5
Niepowiązane: Jak wygenerowałeś taki ładny zrzut ekranu?
Paul Lammertsma
1
@Paul: po tym, jak ten mem okazał się „obowiązkowy” ( meta.stackexchange.com/questions/19478/the-many-memes-of-meta/… ), musiałem użyć FSCapture ( faststone.org/FSCaptureDetail.htm ) do wykonania;)
VonC
Snipping Tool załatwia sprawę na Win7. Dzięki za zrzut ekranu. Właśnie tego potrzebowałem dzisiaj! :)
Joseph Lust
1
W przypadku użytkowników komputerów Mac plik eclipse.ini znajduje się w Eclipse.app/Contents/MacOS/, jeśli klikniesz prawym przyciskiem myszy i przejdziesz do Pokaż zawartość pakietu
Aram Kocharyan
To samo dotyczy Zend Studio na Maca. ZendStudio.iniZnajduje się Applications/Zend Studio.app/Contents/MacOS/.
rofflox
6

Spójrz na Window -> Preferences -> Java -> Editor -> Templates.

Binil Thomas
źródło
Tak, wiem o tym, ale niestety nie wydaje się to mieć żadnego wpływu na generowanie kodu dla klas. Chcę uniknąć konieczności robienia tego ręcznie
Olaseni
3

Spring Tool Suite (popularne dostosowanie Eclipse do programowania Spring) używa STS.ini. W systemie Windows znalazłem go w tym samym katalogu, co plik wykonywalny aplikacji.

Alexey Slepov
źródło
W przypadku STS w systemie Mac OS zobacz odpowiedź VonC podczas przeszukiwania pakietu aplikacji STS.
Kent Bull
3

Aby użyć nazwy użytkownika i adresu e-mail Git, możesz użyć zmiennych ${name:git_config(user.name)}i ${email:git_config(user.email)}.

wprowadź opis obrazu tutaj

chrisjleu
źródło
Znajduje się podPreferences / Java / Code Style / Code Templates / Comments / Types
timbru31
1

Powinieneś rozważyć użycie JAutodoc , który jest bardzo przydatną wtyczką do Eclipse. Parametryzacja jest dużo bardziej zaawansowana niż standardowa generacja Eclipse.

Julien
źródło
Czy istnieje sposób na zastąpienie generowania zaćmienia javadoc przez Eclipse za pomocą JAutoDoc? Chodzi mi o to: mam zainstalowaną wtyczkę JAutoDoc. Jeśli teraz generuję metody get / setter za pomocą Shft + Alt + S i wybierając „Generuj pobierające i ustawiające ...”, komentarze javadoc są nadal generowane przez zaćmienie. Ale chcę automatycznie generować te komentarze przez JAutoDoc ...
Steffen