Javadoc ve Ant ile ölçüm Dokümantasyonu Kapsamı

Question

Genel API belgelerinin açık bir şekilde teslim edilebildiği bir projede yer alıyorum. Sürümün bu gereksinimi karşıladığından emin olmak için, belge kapsamı çok düşük olduğunda, Ant derleme dosyamdaki yayın hedefinin başarısız olmasını sağlamak isterim.

asgari olarak, kamu veya korumalı erişim Her tanımlayıcı uygun Javadoc etiketlerini ve bir açıklama olmalıdır. Dönüş türü void, her özel durum için bir @throws etiket ve tek bir hat açıklama değilse Örneğin, kamu yöntemleri, her parametre için bir @return etiketi bir @param etiketi olmalıdır.

Şu anda cobertura kullanarak JUnit kod kapsamı raporları ve başarısızlık koşulları var, bu yüzden dokümantasyon için benzer bir şey mükemmel olurdu. Ancak, bir arıza durumunun tespit edilmesi mümkün değilse, rapor makul bir ikame olabilir.

dokümantasyon Javadoc formatında olmalıdır. Doxygen de dahil olmak üzere başka bir format kabul edilemez.

Answer 1

Checkstyle yapabilir.

Answer 2

Böyle bir araç bilmiyorum ama Doxygen yorumlarla birlikte kod yapısını tanımlayan XML dosyalarını oluşturabilir düşünüyorum. Üzerinde bazı basit testler yapacak ve belgesiz yöntemler/paramlar/geri dönüş değerleri/etc bulabilirsiniz bir komut dosyası yazabilirsiniz.