Sun'ın sitesindeki javadoc belgelerine bakarak, bir sınıfı veya yöntemin jenerik tip imzasını belgelemek için kullanılabilecek bir javadoc etiketi olup olmadığını araştırıyorum.Genel tip parametrelerini belgelemek için bir javadoc etiketi var mı?
Her zamanki gibi @param
benzeri @typeparam
gibi bir şey, ancak yöntemlerin yanı sıra, uygulanabilir. Her yerde onun sözünü bulabilirsiniz ve JavaSE API dosyaları herhangi bir belirtisi göstermezler, ama garip bir eksiklik gibi görünüyor -
/**
* @typeparam T This describes my type parameter
*/
class MyClass<T> {
}
Öyle bir etiket yoktur sanıyorum. Birisi beni doğru yapabilir mi?
uygun javadocs yazmak için? –
* Çoğu * sınıf için gerçekten tip parametresi hakkında söylenecek ilginç bir şey olmadığını unutmayın, çünkü tip parametresi esas olarak nesnenin yöntemlerinde nasıl göründüğü ile tanımlanır. Çoğu zaman @param 'yi atlardım ve sadece gerçekten net olmadığında onu kullanırdım. –
Ne dediğini görüyorum, ama bu mantıkla, aynı yöntem parametreleri için '@ param 'kullanımı için de geçerlidir. Sun'ın kodlama standartları, yöntem parametresinin anlamı açık olsa bile 'param' kullanılmalıdır. – skaffman