一.javadoc
(1)javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
(2)javadoc命令是用来生成自己API文档的,使用方式:在dos中在目标文件所在目录输入javadoc +文件名.java。
(3)
@author 作者名
@version 版本标识
@parameter 参数及其意义
@since 最早使用该方法/类/接口的JDK版本
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@see reference
@override 重写
二.语法:
(1)
public 返回值类型方法名(){
//方法的主体
}
(2)注意:
①方法体放在一对大括号中。方法体就是一段程序代码,完成一定的工作。
②方法名主要是在调用这个方法时使用。在Java中一般采用骆驼命名法。
③方法执行后可能会返回一个结果,该结果的类型称为返回值类型。使用return语句返回值。
三.实例:
电动狮子类:
public class Autolion{
String color=“黄色”; //颜色
/*跑*/
public void run(){
System.out.println(“正在以0.1米/秒的速度向前奔跑。”);
}
/*抢球*/
public void ball(){
String ball=“球”;
return ball;
}
/*获得颜色*/
public String getColor(){
return color;
}
/*显示狮子特性*/
public String showlion(){
return “这是一个”+getColor()+“的玩具狮子!”;
}
}
测试类:
public class Textlion{
public static void main(String[] args){
Autolion lion=new Autolion();
//创建Autolion对象
String info=lion.showlion();
//调用方法并接收方法的返回值
System.out.println(info);
//显示类信息
lion.run();
//调用跑方法
System.out.println(“抢到一个”+lion.robBall());
//调用抢球方法
}
}