Java包机制、Java Doc

包机制

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

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

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

  import package1[.package2...].(classname|*);
  

• 包语句语法格式：

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

Java Doc

• javadoc命令是用来生成自己API文档的
• 参数信息
  • @author作者名
  • @version版本号
  • @since指明需要最早使用的jdk版本
  • @param参数名
  • @return返回值情况
  • @throws异常抛出情况

CMD 生成Java Doc

C:\Users\user\IdeaProjects\JavaSE\基础语法\src\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java

IDEA生成Java Doc

• 打开 idea，点击 Tools-> Generate JavaDoc，这样会打开生成 javadoc 文档的配置页面。

• 进行配置：

  标注的是重要的部分，从上往下分别是配置 javadoc 的范围，输出文件夹路径以及命令行参数。

  这里的命令行参数很重要，因为只有使用 utf-8 编码才能保证生成时可以正常处理中文字符，所以一定要加上：

  -encoding utf-8 -charset utf-8
  

  还可以配置那些注解需要生成，哪些权限类（private、package、protected、public）需要生成等精细控制。

  还有一点需要注意，即不要勾选“Include test sources”，勾选后，会造成错误。