第7篇 包机制和JavaDoc文件生成

合集 - JavaSE(15)

1.第4篇 用javac和java命令输出HelloWord2023-11-252.第5篇 基本语法篇（注释、基本数据类型、类型转换、变量、命名规则和关键字）2023-11-253.第6篇 运算符2023-11-27

4.第7篇 包机制和JavaDoc文件生成2023-12-04

5.第8篇 逻辑结构（switch和增强for）2023-12-046.第9篇 方法知识点综合（求值策略与可变参数）2023-12-047.第10篇 数组2023-12-048.第11篇 类对象2023-12-049.第12篇 jvm 内存模型JMM2023-12-0410.第13篇 继承知识点综合2023-12-0411.第14篇 多态知识点综合2023-12-0412.第15篇 抽象类与接口2023-12-0413.第16篇 内部类2023-12-0414.第17篇 异常与日志2023-12-0415.IDEA快捷键2023-12-04

收起

1. 包机制

1.1 语法格式

package pkg1[.pkg2[.pkg3...]];

注意：

​ 此句必须放在文件最开始位置

---

1.2 提倡的命名格式

一般利用公司的域名倒置作为包名

如 www.baidu.com 其包名就推荐命名为 com.baidu.www

---

1.3 引用包

import package pkg1[.pkg2[.pkg3...]].(classname|*);

​ - 导入自定义文件时，一般无需添加文件类型 .(classname|*)，只写到文件名即可

​ - *号是万能符，可以简单理解成“所有”，和SQL一样用法

例如：

import java.utol.Date;
import java.util.Scanner;

---

1.4 静态导入包

​ import static [包名] . [方法名];

import static [包名] . [类属性];

• 方法名无需加括号，导入后可在该文件内直接调用该方法，无需再用 [包名] . [方法名]的形式

//使用静态导入包前
import java.lang.Math;
System.out.println(Math.random());
System.out.println(Math.PI);
 
//使用静态导入包后
import java.lang.Math.random;
import java.lang.Math.PI;
 
System.out.println(random());
System.out.println(PI);

---

1.5 JDK1.8 API文档

JDK8 API 在线文档 全英文

JDK8 API 在线文档 中文

JDK1.8 API文档中文与英文版的离线版：这个哥们提供了一个：

下载源

---

2. JavaDoc生成

2.1 命令行生成JavaDoc文档：

javadoc -encoding UTF-8 -charset UTF-8 [文件名].java

结果：

生成了好几个文件，其中 index.html打开后与 1.4 节中的在线API文档界面相似

C:\Users\Administrator\Desktop\src\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java
正在加载源文件Doc.java...
正在构造 Javadoc 信息...
标准 Doclet 版本 1.8.0_391
正在构建所有程序包和类的树...
正在生成.\base\Doc.html...
Doc.java:14: 警告: @param 没有说明
     * @param name
       ^
Doc.java:15: 警告: @return 没有说明
     * @return
       ^
Doc.java:16: 警告: @throws 没有说明
     * @throws Exception
       ^
Doc.java:4: 错误: 未知标记: auther
 * @auther wendao101
   ^
正在生成.\base\package-frame.html...
正在生成.\base\package-summary.html...
正在生成.\base\package-tree.html...
正在生成.\constant-values.html...
正在构建所有程序包和类的索引...
正在生成.\overview-tree.html...
正在生成.\index-all.html...
正在生成.\deprecated-list.html...
正在构建所有类的索引...
正在生成.\allclasses-frame.html...
正在生成.\allclasses-noframe.html...
正在生成.\index.html...
正在生成.\help-doc.html...
1 个错误
3 个警告
 

---

2.2 IDEA生成JavaDoc文档：

Tool==>Generate JavaDoc

其他参数设置：

• output directory: 生成路径

• Locale：设置语言区域，决定文档的语言

  • 简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww

• Command line arguments：(其他命令行参数)：

  • 编码设置: 参数一般为-encoding UTF-8 -charset UTF-8