Java API (Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
Package储存各种class,可以解决class重名问题,也根据不同的class分类放进不同的包便于管理。
在包里的class文件 第一句都是 package + 包名
包名的写法:域名倒着写,再加上模块名,并与内部管理类
以cn.ecjtu.learnning为例如下:
package cn.ecjtu.learnning;
public class Test_HelloWorld {
public static void main(String[] args) {
// TODO Auto-generated method stub
System.out.println("Hello World 你好 世界!");
int a=32;
int b=a*3;
int c=b*4;
System.out.println(c);
}
}
注意cn.gao和cn.gao.car,这两个包没有包含关系,是两个完全独立的包。只是逻辑上看起来后者是前者的一部分。
如何生成自己的API文档
·特殊注释 /**
·使用JavaDoc生成API文档,解决代码和注释分离的问题
·常用的Java注释标签:
-@Author 作者
-@version 版本
-@param 参数
-@ruturn 返回值的含义
-@throws 抛出异常描述
-@deprecated 废弃。 建议用户不再使用该方法
package cn.ecjtu.learnning;
/**
* 递归算法计算阶层
* @author Administrator
* @version 1.0
*/
public class Factorial {
public static long multi(int n) {
if (n == 1) {
return 1;
} else {
return n * multi(n - 1);// 再次调用乘法,递归形成阶乘
}
}
public static void main(String[] args) {
// TODO Auto-generated method stub
System.out.println(multi(5));
}
}
写好注释后,在项目单击右键打开项目属性,点击Export(输出);再点击Java文件夹下的Javadoc ,然后选定文件夹
之后Finish;Yes To All
接着相应的文件夹下找到doc文件夹,doc文件夹下的index.html就是生成的API文档
C:\JAVA_Workspace\cn.ecjtu.learnning\doc\index.html