JAVA Javadoc
一、javadoc定义
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。
二、常用标记
三、示例
/**
- show 方法的简述
-
show 方法的详细说明第一行
- show 方法的详细说明第二行
- @param b true 表示显示,false 表示隐藏
- @return 没有返回值
*/
public void show(boolean b){
frame.show(b);
}