JavaDoc文档生成

JavaDoc文档生成

JavaDoc是一种将注释生成HTML文档的技术。

1、使用javadoc命令生成文档

 

  • 首先了解javadoc指令

     

JavaDoc文档生成_第1张图片
 

  • 使用指令生成文档,这里的java文件的编码是utf-8,所以要带上编码选项 -encoding utf-8
    指令 javadoc -encoding utf-8 Fish.java
    JavaDoc文档生成_第2张图片
     
  • 打开index.html文件
    JavaDoc文档生成_第3张图片
    JavaDoc文档生成_第4张图片
     

2、使用eclipse生成文档

  • 选中java文件,右键选择Export,进入Export界面,选Java-Javadoc
    JavaDoc文档生成_第5张图片
     
  • 点击Next,选中目录
    JavaDoc文档生成_第6张图片
  • 两次一直选择Next,配置VM options指定源文件编码为 -encoding utf-8 , 点击Finsh
    JavaDoc文档生成_第7张图片
     
  • 查看生成文档过程的信息与文档
    JavaDoc文档生成_第8张图片
    JavaDoc文档生成_第9张图片

3、 Intellij Idea生成JavaDoc

     参考:常用工具说明-- Intellij Idea生成JavaDoc

 


【Java面试题与答案】整理推荐

  • 基础与语法
  • 集合
  • 网络编程
  • 并发编程
  • Web
  • 安全
  • 设计模式
  • 框架
  • 算法与数据结构
  • 异常
  • 文件解析与生成
  • Linux
  • MySQL
  • Oracle
  • Redis
  • Dubbo

 

你可能感兴趣的:(文档)