Przeglądałem dokumentację javadoc w witrynie Sun, próbując znaleźć znacznik javadoc, który może być użyty do udokumentowania ogólnego podpisu typu klasy lub metody.
Coś podobnego @typeparam
, podobnego do zwykłego @param
, ale pasującego do typów i metod, np
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
Podejrzewam, że nie ma takiego tagu - nigdzie nie mogę znaleźć o nim wzmianki, a dokumentacja JavaSE API nie wykazuje żadnego znaku, ale wydaje się, że jest to dziwne pominięcie. Czy ktoś może mnie naprawić?
@param <T>
większość czasu i używam go tylko wtedy, gdy jest naprawdę niejasny.@param
parametrów metody for. Standardy kodowania firmy Sun wyraźnie mówią, że@param
powinno się to stosować, nawet jeśli znaczenie parametru metody jest jasne.Odpowiedzi:
Należy to zrobić tak:
Źródło
źródło
Collection
) Go nie używają.Tak. Po prostu użyj tagu @param i umieść nawiasy ostre wokół parametru type.
Lubię to:
źródło