JavaDoc @Class for MyClass kurucusu bir uyarı döndürüyor "referans bulunamadı"

Question

İstemci kitaplığım için javadoc oluşturmaya çalışıyorum. MyOtherClass'da, aşağıdaki @ 'ı koyup uyarıları alıyorum. MyOtherClass ve MyClass'ın ikisi de aynı projede farklı paketlerde.

@see MyClass#Constructor(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyClass#Constructor(Type1 param1, Type2 param2) 

Sonra

@see MyClass#MyClass(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyClass#MyClass(Type1 param1, Type2 param2) 

Ayrıca

@see #MyClass(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyOtherClass#MyClass(Type1 param1, Type2 param2) 

Ben burada gerçek saçma şey eksik biliyorum çalıştı çalıştı.

Answer 1

Bunun sebebi, Javadoc'un başvuruda bulunduğunuz sınıfın tam konumunu bilmesi ve ona bir bağlantı oluşturmasıdır. Sadece yukarıdaki yorumda belirtildiği gibi paketi ekleyin.

@see mypackage.MyClass#Constructor(Type1 p1, Type2 p2) 

javadoc aracı aşağıdaki gibi kısayollar almaya izin verir:

@see mypackage.MyClass#Constructor(Type1 p1, Type2 p2) MyClass#Constructor(Type1 p1, Type2 p2) 

: Uzun bir paket adı var ve bunu gizlemek isterseniz

// For methods in the same class: 
@see #Constructor(Type1 p1, Type2 p2) 

// For methods in the same package: 
@see MyClass#Constructor(Type1 p1, Type2 p2) 

bir etiket kullanabilirsiniz

Yukarıdakiler görüntülenecektir:

Ayrıca bkz .:MyClass.Constructor(Type1 p1, Type2 p2)

@see

---

Uyarı devamı için Oracle belgelerine here bakınız: bazı IDE kod tamamlama özelliğini (Ör Eclipse) Javadoc yorumları oluşturmak için referans olarak verdiğiniz paket için bir ithalat ekleyebilirsiniz. Bu, yorumlarınızı paket adını hariç tutarak daha temiz görünmesine neden olsa da, belgelere yalnızca gerçek bağımlılıklar eklemek iyi bir uygulama değildir.