@See ve @inheritDoc arasındaki farkın ayrıntıları

JavaDoc referansına baktım ve @see(çeşitli bağlantılar) ve {@inheritDoc}(süper sınıf JavaDoc yorumunun dışa aktarımı ) arasındaki temel farkı anlarken, şeylerin gerçekte nasıl uygulandığına dair açıklamaya ihtiyacım var.

Eclipse IDE'de, miras alınan yöntem için (arabirimden veya toString () geçersiz kılma vb.) İçin "Öğe Yorumları Oluştur" u seçtiğimde, aşağıdaki yorumu oluşturuyor

/* (non-Javadoc)
 * @see SomeClass#someMethod()
 */

Ben üretim JavaDoc'u için gerekli ediyorum ben yerine, öyle bırakabilir gerektiğini @seeile {@inheritDoc}, veya bunu çevirmek iyi niyetli gibi JavaDoc'u:

/**
 * {@inheritDoc}
 */

Ve bunu yaptığımda sınıf # yöntem bayrağını tutmalı mıyım?

Her şeyden önce, orijinal tutulma şablonunu kaldırmalısınız çünkü bu sadece gürültülü bir gereksizdir. Ya anlamlı dokümanlar koyun ya da hiçbir şey koymayın. Ancak, IDE şablonlarını kullanarak bariz olanın gereksiz şekilde yeniden ifade edilmesi sadece kodu karıştırır.

Eğer üretim javadoc gerekmektedir, ikinci olarak, o zaman var olan açıklama başlangıç yapmak /**. Aksi takdirde, javadoc değildir.

Son olarak, geçersiz kılıyorsanız, kullanmalısınız @inheritDoc( @seh bir yorumda belirtildiği gibi, orijinal dokümanları eklemek istediğinizi varsayarak , sadece orijinal dokümanları kopyalamak istiyorsanız, o zaman hiçbir şeye ihtiyacınız yoktur). @seegerçekten yalnızca diğer ilgili yöntemlere başvurmak için kullanılmalıdır .