使用javadoc命令生成API文档

柔情只为你懂 2023-07-04 03:19 5阅读 0赞

1. 编写代码,并添加注解

  1. /**
  2. * test
  3. * @author admin
  4. * @version 1.0
  5. * @since 1.5
  6. */
  7. public class APITest {
  8. /**
  9. * 计算两数的和
  10. * @param a 整数
  11. * @param b 整数
  12. * @return 两数的和
  13. */
  14. public int add(int a, int b ){
  15. return a + b;
  16. }
  17. }

【注】
(1)注释要尽可能写的详细;
(2)注释格式为 `/………/** ,而不是/………*/`

2.更改编码

  • 可以使用 Notepad++ ,将要生成API文档的类的 .java 文件的编码格式改为 ANSI编码(本地默认编码)
  • 因为 .java 文件默认编码格式可能为 UTF-8编码若不修改编码格式,生成的文档可能会有乱码

3.使命javadoc命令
在这里插入图片描述

  • 输入 javadoc 类名.java 再回车之后,便会生成许多 html 文件,打开其中的 index.html 便可看见刚刚生成的文档
    在这里插入图片描述

发表评论

表情:
评论列表 (有 0 条评论,5人围观)

还没有评论,来说两句吧...

相关阅读

    相关 JavaDoc生成API

    一、综述 1.简介   Javadoc是Java自带的一种工具,其可以从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只