Java基础语法（四）包机制、JavaDoc生成文档

Java基础语法（四）

目录

• Java基础语法（四）
  • • 包机制
      • • 包的本质和创建
        • 包的导入
    • JavaDoc生成文档

包机制

包的本质和创建

1. 包（package）

2. 包的本质：类似于Windows里的文件夹

3. 一般用公司域名倒置作为包名：（例：com.baidu 指放到com包里的baidu包下）

   package com.baidu;
   

4. java文件头部是该文件的所在地址，例如在com.baidu里建立的一个java文件，该文件上方显示package com.baidu;代表该文件在哪个包里
   

包的导入

1. 用import导入包

2. 导入包中的某个文件

   例：导入com.baidu包里的Dome文件：

   import com.baidu.Dome;
   

3. 导入包中的所有文件（用*）

   例：导入com.baidu包里的所有文件：

   import com.baidu.*;
   

JavaDoc生成文档

1. 参数信息：

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

   //类注释
   package com.baidu;
   /**
   *@author 史小鹏
   *@version 1.0
   *@since 1.8
   */
   public class l1 {
       
   }
   

   2. 方法注释

   在方法上面输入/**再回车会自动生成该方法的参数，返回名之类的

   例：

   //方法注释
   public class l1 {
       String name;
       /**
        *
        * @param name
        * @return
        */
       public String test(String name){//方法
           return name;//方法的返回值
       }
   }
   

   //方法注释
   public class l1 {
       String name;
       /**
        * 
        * @param name
        * @return
        * @throws Exception
        */
       public String test(String name)throws Exception{
           return name;
       }
   }
   
   

2. 将java文件生成文档：

   在该文件的文件夹下打开cmd，输入javadoc -encoding UTF-8 -charset UTF-8 文件名.java

   回车后生成该java文件的文档

   javadoc -encoding UTF-8 -charset UTF-8 abc.java //生成abc.java的文档
   

   生成文档之后点击index.html（首页）进入文档首页