«javadocs» etiketlenmiş sorular

Son zamanlarda şu anda uğraştığım kod tabanının parçalarını yeniden düzenleme üzerinde çalışıyorum - sadece kendimi daha iyi anlamak için değil, aynı zamanda kod üzerinde çalışan diğerleri için de daha kolay hale getirmek için. Kendini belgeleyen kodun güzel olduğunu düşünmeye eğilimliyim . Sadece daha temiz olduğunu düşünüyorum ve kod kendisi için …

18 java  documentation  refactoring  javadocs 

Bir yöntem veya API'nin kod tabanında olduğu, ancak uygulamasının tamamlanmadığı veya büyük olasılıkla değişeceği için kullanılmaması gerektiği anlamına gelen "kullanımdan kaldırma" ifadesinden farklı ancak iyi bir terim var mı? (Evet, biliyorum, bu yöntemler herkese açık olmamalı, yada yada yada. Durumumu yaratmadım, sadece en iyisini yapmaya çalışıyorum.) İnsanlar ne önerir? Deneysel, …

12 documentation  terminology  api  documentation-generation  javadocs 

Bunun için JavaDoc'ta X509Certificate getSubjectDN()şunları belirtir: Reddedildi , yerine getSubjectX500Principal () getirildi. Artık kullanılmaması gereken, ancak Denigrated değil yöntemleri için Kullanımdan kaldırılmış görmek için alışkınım. Yorum ile kapatıldığı bu özel durum hakkında bir hata raporu buldum : Bu bir hata değil. "Kullanımdan kaldırıldı", yalnızca ciddi durumlarda kullanılması amaçlanmaktadır. Kullanımdan kaldırılmış …

11 java  terminology  javadocs 

Temel, iyi bilinen dize metriklerinin uygulamalarını sağlayan küçük bir kütüphane üzerinde çalışıyorum. Çoğunlukla kendi eğitimim için. Yani biraz boş zamanım olduğunda gelişme olur. Bu nedenle, çoğu işlemi otomatikleştirdim, böylece çok fazla çaba harcamadan çalıştığım kadar sık ​​bir sürüm yayınlayabilirim. Bununla birlikte, Java belgesini korumak hala bir yüktür çünkü örnekler içerir. …

9 java  documentation  javadocs 

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?

9 documentation  comments  dry  javadocs