java 7 api中文的_第三模块：java基础--JavaDoc

javadoc是一种将注释生成HTML文档的技术，是用来生成自己的API文档，易读且清晰明了，对于程序是不可或缺的。

一、常用的文档注释

package 

二、Javadoc文档的生成

1.命令行生成

打开cmd，找到需要生成的类所在的文件夹，输入以下命令：

Javadoc -encoding UTF-8 -charset UTF-8 Doc.java

接着，找到所在的文件夹，打开里面的index.html文件，就是所要的javadoc文档

2.使用idea生成

打开idea开发工具，找到Tools-->Generate JavaDoc

1.选择是整个项目还是单个模块

2.文档的输出路径（保存的地方）

3.Local选择地区，决定了文档的语言，中文就是zh_CN

4.传入JavaDoc参数，一般为-encoding UTF-8 -charset UTF-8 -windowtitle "文档标题内 容" -link http://docs.Oracle.com/javase/7/docs/api

第一个参数：表示源代码是基于UTF-8编码的，避免出现中文等非英文字符乱码

第二个参数：生成的JavaDoc文本使用的字符集也是UTF-8编码的。目前大部分浏览器都支持此编码方式，具有通用性，支持中文非常好

第三个参数：表示生成的JavaDoc超文本在浏览器中打开时，浏览器窗口标题栏显示的文字内容

第四个参数：表示生成的JavaDoc超文本中涉及到很多对其他外部Java类的引用，是使用全限定名称还是带有超链接的短名称。对于一些限定，就是指向官方JavaSE标准文档

JavaSE 标准文档地址​docs.oracle.com

学习资料大家可以参考下面的链接：（个人分享，无任何广告）

【狂神说Java】Java零基础学习视频通俗易懂_哔哩哔哩 (゜-゜)つロ 干杯~-bilibili​www.bilibili.com

对于做开发的小伙伴，最好可以看一下阿里巴巴java开发手册（网上直接搜索）

2020年11月24日

向上Lin！