2011-01-13 18 views

cevap

6

Javadoc nesil (.html dosyaları yazma) on-demand (Araçlar-> Javadoc üret) sizin için yapılır ve bunu kurmak kez esasen otomatiktir. Eclipse için jautodoc'un yaptığı, javadoc stubs kestirimi, yöntem-yöntem, sınıf-sınıf ve yalnızca bunu söylediğiniz şekilde yapılır.

Bir yöntem imzasının üstünde /** <enter> yazarak, sizin için Javadoc dizeleri oluşturacaktır. Tüm dosya, paket veya proje için (jautodoc gibi) bunu yapacak bir şey istediğinizden şüpheliyim. Böyle bir eklenti vardı: http://plugins.intellij.net/plugin/?id=952, ancak 10 ile çalışmayacaktır.

Bu jautodoc örneğinin, düzgün bir parti numarası olsa da, şimdiye kadar gördüğüm en işe yaramaz şey olduğunu söylemek zorundayım IDE: Değişken ismine dayalı bir tanım oluşturur - ancak değişken adı sadece açıklayıcıysa, ilk etapta bir yoruma gerek duymaz.

/** 
* The number of questions 
*/ 
private int numberOfQuestions; 

Delikli kart için özlem yapar.

+5

Bazı derleme sistemleri, checkstyle, jalopy vb. Kullanır. Sonuç olarak, kullanıcıların topal javadocs eklemesi gerekir. En iyi uygulama, kodunuzun kendi kendine konuşmasını sağlamaktır, ancak şirket politikanız gereği veri bloğu oluşturduğunuzda sıkışmış olduğunuzda, jautodoc gibi işlevlerin olması güzeldir. ctrl alt j ve işlemek için iyi. – branchgabriel