首页 > 编程语言 > 详细

JavaDoc生成文档

时间:2021-01-11 20:47:38      阅读:29      评论:0      收藏:0      [点我收藏+]

JavaDoc生成文档

百度搜索:阿里巴巴开发手册,仔细看!

百度搜索:java SE 文档——API和文档,即在线API帮助文档https://docs.oracle.com/javase/8/docs/api/,挑重点的有用的学习

文档注释:加在类前面是类的注释,加在方法前面是方法的注释

package com.li.base;

/**
 * @author liyang
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     * @author liyang
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

1. 通过命令行生成JavaDoc文档

  1. 在类上右键-->Open in-->Explorer
  2. 在地址栏输入cmd,即在此类所在文件夹打开控制台
  3. DOS命令:javadoc -encoding UTF-8 -charset UTF-8 Doc.java( -encoding UTF-8 -charset UTF-8是为了解决可能出现的中文乱码问题)
  4. 文件夹会生成一堆文件,打开index.html
  5. 便会看到生成的JavaDoc文档

技术分享图片

技术分享图片

生成的文档:

技术分享图片

打开文件index.html后的界面

技术分享图片

2. 通过IDEA生成JavaDoc文档:选中要生成的类-->Tools-->Generate JavaDoc...

JavaDoc生成文档

原文:https://www.cnblogs.com/llcode/p/14263688.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!