JavaDoc---生成自己的API文档

JavaDoc 生成自己的API文档

  • JavaDoc命令是用来生成自己API文档的
  • 参数信息
    • @author 作者名
    • @version 版本号
    • @since 指名需要最早使用的jdk版本
    • @param 参数名
    • @return 返回情况
    • @throws 异常抛出情况
/**
 * @author: Flonx
 * @param: name
 * @throws Exception
 */

如何使用

  • 找到java文件对应目录 (可通过idea里点击文件右键进入, 也可自行查找)

在这里插入图片描述

1. 通过cmd

  • 在路径栏开头输入cmd+空格, 回车

在这里插入图片描述

  • 输入以下语句:

注意:是javadoc,不是javac, 如果出现"invalid flag: charset", 基本都是因为写成了javac

在这里插入图片描述

  • 运行成功后, 该文件夹会生成许多文件, 其中双击index.html, 即可跳转到自己的API

2. 通过powershell

  • 在路径栏按住shift, 右键屏幕, 点击open powershell window here

在这里插入图片描述

  • 之后步骤与cmd方法相同

3.通过idea

  • 找到tools—> Generate JavaDoc

在这里插入图片描述

在这里插入图片描述

  • 第一项根据自己需求选择即可, 输出目录自己选择合适位置, 第三项区域位置可选zh_CN, 第四项填写:"

    -encoding UTF-8 -charset UTF-8 -windowtitle “接口文档3.4” -link http://docs.Oracle.com/javase/7/docs/api"

    摘自:点击查看原文

  • 点击ok即可在输出路径下生成选择文件的API文档

版权声明：本文为lingluanLYS原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接和本声明。