我在我的业务逻辑中写了很多这样的评论:
/**
* 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 将成为其中的一部分。
是否javadoc
工具也能识别我的方法块内的文档注释吗?
No.
JavaDoc 注释是多行注释,开头为/**
紧接在类声明或类的方法或属性之前。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)