加入收藏 | 设为首页 | 会员中心 | 我要投稿 李大同 (https://www.lidatong.com.cn/)- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置: 首页 > 编程开发 > Java > 正文

javadoc工具是否识别方法中的注释?

发布时间:2020-12-14 16:47:53 所属栏目:Java 来源:网络整理
导读:我在我的业务逻辑中写了很多评论: /** * Do some important stuff. * @param pDog * @param pAllDogTraining * @return */@Overwritepublic MapDogId,Dog doEvaluateAllDog(final Dog pDog,final CollectionDogTraining pAllDogTraining) {final MapDogId,D
我在我的业务逻辑中写了很多评论:
/**
 * 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将成为其中的一部分.

解决方法

does the javadoc tool recognize the doc comments inside my method blocks too?

没有.

JavaDoc注释是一个以/ **开头的多行注释,紧跟在类声明或类的方法或属性之前.

(编辑:李大同)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

    推荐文章
      热点阅读