JavaDoc

我是一条鲨鱼

于 2021-03-07 21:46:13 发布

阅读量173

点赞数 3

分类专栏： Java基础语法文章标签： javadoc cmd intellij idea

本文链接：https://blog.csdn.net/qq_43500284/article/details/114499682

版权

Java基础语法专栏收录该内容

6 篇文章 0 订阅

订阅专栏

JavaDoc

javadoc命令是用来生成自己API文档的
1. 将当前类在文件夹中打开，右击当前类，选中open in explorer
  
  $[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ngWYZDaN-1615124653414)(C:\Users\jiangzhicheng\Desktop\自学之路\基础语法学习\类在文件夹中打开.png)]$
2. 通过资源管理器的地址栏进入cmd
3. 执行 javadoc -encoding UTF-8 -charset UTF-8 Doc.java
4. 在生成的文件中找到 index.html 并打开
参数信息
- @author作者名
- @version版本号
- @since指明需要最早使用的jdk版本
- @param参数名
- @return返回值情况
- @throws异常抛出情况

package com.jiang.base;
/**
 * @author ImaShark
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

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