javadoc工具是否可以识别方法中的注释？

我已经写了很多的评论我的商业逻辑里那样：javadoc工具是否可以识别方法中的注释？

/** 
* 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工具认识我的方法块内部的文档注释吗？在不久的将来，我们将提供技术文档，我们项目的JavaDoc将成为其中的一部分。

来源

2013-03-19 Stefan Beike

评论里面的方法通常是文档实现细节。 JavaDoc应该描述类/方法的接口（API）。所以这是两个不同的东西，不应该混合在一起。 – NilsH 2013-03-19 10:10:54

javadoc工具是否识别我的方法块内的文档注释？

号

Javadoc注释是一个多行注释开始/**立即之前类声明或类的方法或属性。

来源

2013-03-19 10:06:34

javadoc工具是否可以识别方法中的注释？

回答

相关问题