Java的包机制以及Javadoc文档生成

包机制

• 包语句的语法格式为：package pkg1[.pkg2[.pkg3...]];

• 一般利用公司域名倒置作为包名：例如百度：com.baidu.www

• 为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包，语法格式为：import package1[.package2[.package3...]].(classname|*);

• 尽量不让类重名

JavaDoc文档生成

• 1.通过命令行 在对应目录下：Javadoc 参数 Java文件

  例如：javadoc -encoding UTF-8 -charset UTF-8 Doc.java

  ​ 编码 字符集编码

• 2.通过idea生成javadoc文档

• Locale 选择地区，这个决定了文档的语言，中文就是zh_CN

• 传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

• 参数信息：

  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况