Javadoc'u KURU bir şekilde yazmak istiyorum. Ancak Javadoc hakkındaki oracle belgesi , aşırı yük yöntemi yorumunda tekrar aynı şeyi yazdığını söylüyor. Tekrardan kaçınamaz mıyım?
Javadoc'u KURU bir şekilde yazmak istiyorum. Ancak Javadoc hakkındaki oracle belgesi , aşırı yük yöntemi yorumunda tekrar aynı şeyi yazdığını söylüyor. Tekrardan kaçınamaz mıyım?
Yanıtlar:
Ben serpin {@inheritDoc}süper sınıf gelen yöntemleri geçersiz veya arayüz tanımlanmış yöntemler uygularken benim Javadoc yorumlarda orada burada direktifleri.
Bu, en azından benim için iyi çalışıyor, kaynak kodundaki tekrardan kaçınıyor ve buna gerek duyulursa, Javadoc yorumuna belirli bilgiler ekleyebilirsiniz. Javadoc yorum kendisi iyi bir IDE tüm alır referanslar ve tüm ile oluşturulan Javadoc almak için ilişkili tanımlayıcı adının üzerine gelmek olduğunda herhangi bir sorun için oldukça çıplak olduğunu düşünmüyorum.
Dokümantasyonun amacı, bir öğenin gelecekteki kullanıcılarını aydınlatmaktır. Bu kısmen yazarın rahatlığı içindir, böylece birileri işin nasıl çalıştığını anlayamadığında onunla iletişime geçmesi gerekmez. Bununla birlikte, çoğunlukla, bu şeyi kullanması veya desteklemesi gereken insanların yararınadır.
Bu nedenle, yazar için uygunluğun aksine, nokta netlik olmalıdır. İnsanların API belgelerinizde aşağı yukarı avlanmalarını bekleyemezsiniz çünkü esasen kendinizi tekrarlamak için çok tembelsiniz. Berbat et - Javadoc tekrar edecek.
Bununla birlikte, zekiyseniz, işaretlerinize veya diğer bazı kriterlere göre yorumlarınızı kodunuza yapıştıracak bir program yazamazsınız. Değerinden daha fazla sorun olabilir. Ya da değil.