api文档、packpage的概念、生成自己项目的api文档

  • API是什么?
    Application Programming Interface 应用程序编程接口

  • packpage的简单使用
    java中的核心包:java.lang包

  • 为什么需要packpage?
    1.为了解决类之间的重名问题。
    2.为了便于管理类,合适的类位于合适的包!

  • packpage怎么用?
    1.通常是类的第一句非注释性语句。
    2.包名:域名倒着写即可,再加上模块名,并与内部管理类。

  • 注意事项
    1.写项目时都要加包,不要使用默认包。
    2.com.gao和com.gao.car,这两个包没有包含关系,是两个完全独立的包。只是逻辑上看起来后者是前者的一部分。

  • JDK中主要的包
    1. java.lang 主要包含一些java语言的核心类,如String、Math、Integer、System和Thread,提供常用功能。
    2. java.awt 包含了构成抽象窗口工具集(abstract window toolkits)的多个类,这些类被用来构建和管理应用程序的图形用户界面(GUI)。
    3. java.net 包含执行与网络相关的操作的类。
    4. java.io 包含能提供多种输入/输出功能的类。
    5. java.util 包含一些实用工具类,如定义系统特性,使用与日期相关的函数。

  • 生成自己项目的API文档
    1.特殊注释: —文档注释: /**
    2.使用JAVADOC生成API文档 —–解决问题:代码和文档的分离
    3.常用的java注释标签:@Author 作者 @version 版本 @param 参数 @return 返回值的含义 @throws 抛出异常描述 @deprecated 废弃。建议用户不在使用该方法
重点:用鼠标点到项目文件夹,选择export选项,然后选择java选项中Javadoc,再选择next,然后再选择你jdk中bin目录下javadoc.exe的所在路径,选择之后选择finish。你会看到你的项目目录下多一个doc文件夹,点开之后找到index.html,你就会看到API文档了。要想有API文档前提是你自己在写代码时,得加文档注释!!!!!
package theChildOfGod.bjxy.test;

/**
 * 测试递归算法的基本流程,并且写了一阶乘的例子
 * @author 徐子峰
 * @version 1.0
 * 
 */
public class TestFactorial {

    /**
     * 计算阶乘。
     * @param n n阶乘的最大数
     * @return 阶乘的结果值
     */
    public static long factorial(int n) {
        if (n == 1) {
            return 1;
        } else {
            return n*factorial(n-1);
        }
    }

    /**
     * 
     * @param args
     */
    public static void main(String[] args) {
            long s =  factorial(5);// 计算5的阶乘
            System.out.println(s);
    }
}
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值