Cześć.
Poszukuję narzędzia/wtyczki/wzorca komentarza/dobrego tutoriala Eclipse, który zautomatyzowałby częściowo tworzenie przeze mnie komentarzy metod do Javadoc wg. wzorca:
@param param1 typ
@param param2 typ
...
@return nazwa typ
Znalazłem w Eclipse w preferencje / Java Code Styles / Code Templates zmienną ${tags} jednak wyciąga ona jedynie nazwy parametrów, oprócz nazw chciałbym wyciąganie typu.
ranides się poskrobał po głowie... jeszcze nigdy w życiu nie widziałem komentarzy javadoc, które zawierałyby typ o_O
Przecież w javadoc umieszczasz tylko nazwy:
* @param param1 zrozumiały ludzki opis
* @param param2 zrozumiały ludzki opis
* @param param3 zrozumiały ludzki opis
typy to widziałem w phpdoc albo jsdoc, bo to dla języków bez statycznego typowania. Ale nawet tam to idzie wg innych konwencji, niż ta, którą wskazałeś.
@param {typ} param1 opis...
@param {typ} param2 opis...
@param {typ} param3 opis...
@param typ $param1 opis...
@param typ $param2 opis...
@param typ $param3 opis...
No i tego nie da się generować w żaden sposób automatycznie, bo przecież nie ma z czego - w php/javascript w deklaracjach typów nie umieszczasz. No to jest sens umieszczać w dokumentacji. Z kolei w javie generować by się dało - tylko pytanie po co, skoro już w deklaracji jest. Myślę, że najlepiej będzie, jeśli skorzystasz ze wskazówki, którą dał Ci Eclipse: skoro domyślnie nie ma takiej opcji, to widać nikt sub sole tak nie robi, i też lepiej nie rób ;)
W jakim celu chcesz mieć tam typ?
Typy parametrów i tak widać po sygnaturze metody.
Poza tym, jeżeli Javadoc zawiera jedynie dane, które można przeczytać z sygnatury metody, to w ogóle nie opłaca się go robić. Javadoc jest przydatny tylko, gdy działanie metody lub znaczenie parametrów nie jest oczywiste.