java技术文档_学习编写java类的技术文档 | 学步园

学习编写java类的技术文档

刚刚学习了毕老师的自学课程的第六天内容，来练习一下写类的技术文档。

用的是《java数据结构与

/**

银行账户类，可以建立一个账户，存钱，取钱，查询余额

@param author huangll

@param version 0.1

*/

class BankAccount

{

private double balance; //account balance账户余额

/**

建立一个账户

@param openingBalance 开户时的初始金额

*/

public BankAccount(double openingBalance) //constructor 构造函数

{

balance=openingBalance;

}

/**

存款

@param amount 存款的金额

*/

public void deposit(double amount) //makes deposit

{

balance=balance+amount;

}

/**

取款

@param amount 取款的金额

*/

public void withdraw(double amount) //makes withdrawal

{

balance=balance-amount;

}

/**

显示余额

*/

public void display() //display balance

{

System.out.println("balance="+balance);

}

} //end class BankAccount

生成文档命令

javadoc -d bank -author -version BankAccount.java

生成一个文件夹bank

里面的index.html是这个类的说明文档

class的说明：这个类是干什么的

@param author    ....

@param version   ....

方法的说明：这个方法是干什么的

@param 方法的参数 接收的是什么

............................

@return 方法返回的是什么

要想给这个类做技术文档，类的访问权限必须是public

只有权限为public或protected的方法才出现在技术文档中

默认构造函数的权限和类的权限一致

但是如果构造函数写出来

BankAccount() { }

如上，它就不是默认构造函数了，它的访问权限也不是public