Java学习 (九)基础篇 包机制&JavaDoc

包机制

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

  包语句的语法为：

  package pkg[.pkg2[.pkg3...]];
  
  

• 一般利用公司域名倒置作为包名；com.feng.xxx

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

import package [.package...].(classname|*); 

import com.luo.base.demon1;	//导入该路径下的demon1
import com.luo.base.*;		//导入包下所有的类

---

JavaDoc

• Javadoc用来生成API文档

步骤

1.点击需要生成文档的源码，我这里以Doc.java为例

2.鼠标右键Doc，点击Open In，点击Explorer

3.在打开的地址栏前输入cmd，打开Dos窗口

4.在Dos窗口里输入 javados -encoding UTF-8 -charset UTF-8 Dos.java(两处UTF-8是将代码里的中文正常显示，以免报错)

红框出现此内容则成功，警告不用管

5.返回之前的文件夹，发现其中出现很多东西，找到index.html，双击进入

6.打开的浏览器页面就是你打开源码的API文档，可以点击进入查看

参数信息

• @author 作者名

• @version 版本号

• @since 指明需要最早使用的jdk版本

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

//当编写代码后，在相应代码前输入/**，按回车则自动输入

/**
 * @author fengye
 * @version 1.4
 * @since 1.10
 */
public class Doc {
    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;