包机制和JavaDoc

转载

mb5fe559b5073e8 2021-09-05 21:04:00

文章标签 javad 帮助文档 java java程序命令行 文章分类 代码人生

包机制和 JavaDoc

包机制

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

*定义包

包语句（package）的语法格式为：

 package pakg1[.pakg2[.pkg3...]];

且必须放在第一行代码

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

例： com.baidu.www
- 尽量不要让包里面的名字重复

*导入包

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

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

如果要导入这个包下所有的类 .* （.* 是个通配符）
```
 import package1.package2.*;
```

JavaDoc

JavaDoc是一种技术，可以把注释信息生成帮助文档（API文档）

参数信息

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

示例

package com.www;
 
 //--------加在类上面就是类的注释---------
             
 /**
  * @author wdt
  * @version 1.0
  * @since 1.8
  */
 public class Doc {
     String name;
                 
 //--------加在方法上面就是方法的注释-------
            
     /**
      * @author wdt
      * @param name
      * @return
      * @throws Exception
      */
     public String test(String name)throws Exception{
         return name;
     }
 }