java包机制和文档

包机制

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

• 包语句语法格式为：

  package pkg1[.pkg2[.pkg3]];

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

  • 比如百度网站为：www.baidu.com

  • 则包名依次为：com.baidu.www

• 为了能够使用某一个包的成员，需要在Java中明确导入该包

  import package1[.package2...].(classname|*);
  //其中*代表导入整个包

生成文档

javadoc命令是用来生成自己API文档的

格式

/**加回车即可开始编写文档注释，格式如下：

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

查看文档注释

• 在代码所在文件夹中打开cmd

• 输入生成文档的指令： javadoc -encoding UTF-8 -charset UTF-8 文件名

• 重新进入该文件夹，点击查看新生成的index.html

• 加在类上面 就是类的注释 加在方法上面 就是方法的注释 面向百度编程

• 作业：学会查找使用IDEA生成javaDoc文档