JAVA基础语法-包机制-JavaDoc

JAVA基础语法-包机制-JavaDoc

包机制

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

• 包语句的语法格式为：

• package pkg1[.pkg2[.pkg3....]];

• 一般利用公司域名倒置作为包名；www.baidu.com com.baidu.www baike

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

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

JavaDoc

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

• 参数信息

• @author 作者名

• @version 版本号

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

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

• //命令行生成JavDoc 文档 
  javadoc -encoding UTF-8-charset UTF-8 Doc.java
      命令-参数-生成文档的java文件名

•  

package com.Ji.base;
/**
 * @author jili
 * @version 1.0
 * @since 1.8
 * */
public class Doc {
    String name;//属性 加到类上面是类的注释
​
    /**
     * @author jili
     * @param name
     * @return
     * @throws Exception
     */
    //方法 加到方法上面是方法的注释
    public String test(String name)throws  Exception{
        return name;
​
    }
}
​