2013-03-19 15 views
11

Ben böyle benim iş mantığı içindeki bir sürü yorum yazdım:Javadoc aracı, yöntem içindeki yorumları tanır mı?

/** 
* Do some important stuff. 
* @param pDog 
* @param pAllDogTraining 
* @return 
*/ 
@Overwrite 
public Map<DogId, Dog> doEvaluateAllDog(final Dog pDog, final Collection<DogTraining> pAllDogTraining) { 
final Map<DogId, Dog> lAllDogBad = new HashMap<DogId, Dog>(); 
final List<DogTraining> lAllDogTraining = new ArrayList<DogTraining>(pAllDogTraining); 

/** 
* Remove deleted entries. 
* Detailed description 
*/ 
removeDeletetTrainings(lAllDogTraining); 

/** 
* Set the priority for each training 
* - bad dogs 
* - nice dogs 
* - unknown dogs 
* Detailed description 
*/ 
Collections.sort(lAllDogTraining, new DogTrainingComparator()); 

// Iterate over training elements and set the conflict state 
for(..... 

, javadoc aracı benim de yöntem blokları içerisindeki doc yorumlarınızı tanıyan var olan sorum? Yakın gelecekte bir teknik dokümantasyon sunacağız ve projemizin JavaDoc'u bunun bir parçası olacak.

+5

Yorumlar bir yöntemde genellikle uygulama ayrıntılarını belgelendirir. Bir JavaDoc, sınıfın/yöntemin arayüzünü (API) tanımlamalıdır. Yani yine de karıştırılmaması gereken iki ayrı şey. – NilsH

cevap

15

javadoc aracı benim yöntem bloklarımdaki doc yorumlarını da tanır mı?

sayılı

Javadoc yorum hemen bir sınıf bildirimi veya sınıfın bir yöntem veya nitelik önce gelen /** ile başlayan bir çok hatlı bir yorumdur.