包机制 以及 JavaDos生成文档笔记

包机制 以及 JavaDos生成文档

包机制

• 为了更好的组织类，Java提供了包机制，用于区别类名的命名方式。

• 包语句的语法格式为：

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

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

  • 例如 www.baidu.com 就会用 com.baidu.www

• 为了能够使用某一个包的成员，我们需要在 Java 程序中明确导入该包。使用“import”语句可以完成此功能。

  • 尽量不要用重复包名

  • *表示把所有包导入程序。

import com.baidu.(classname|*)

JavaDos

• javadoc命令是用来生成自己API（帮助）文档的

• JDK帮助文档 网址https://docs.oracle.com/javase/8/docs/api/

• 参数信息

  • @author 作者名（记下来）

  • @version 版本号（记下来）

  • @since 指明需要最早使用的JDK版本

  • @parpm 参数名

  • @return 返回值情况

  • @throws 异常抛出情况（记下来）

  // 我是通过命令行 javadoc 参数 Doc.java文件

  // 基础部分的一切只是，后面几乎每天都会用到