1.什么是javadoc?
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。
也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
Javadoc用于描述类或者方法的作用。Javadoc可以写在类上面和方法上面。
Javadoc的作用是针对整个方法或者整个类做一个简要的概述的,使得别人不通过看具体方法代码就能知道某个方法或者某个类的作用和功能。
2.javadoc 的基本使用
javadoc注释规范
一、 Java文档
1.// 注释一行
2./ * */ 注释若干行
3./** ……*/ 注释若干行,写入Javadoc文档
二、文档格式
写在类上的文档标注一般分为三段:
第一段:概要描述,通常用一句话或者一段话简要描述该类的作用,以英文句号结束
第二段:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都以英文句号作为结束
第三段:文档标注,用于标注作者,创建时间,参阅类等信息
通过javadoc,我们可以轻松的查阅某个类或者方法的信息——方法的用途,参数的含义,返回值的含义等等…
在我们写自己的代码时,也可以通过javadoc让别人可以轻松的使用我们所编写的代码而不需要查阅相关的文档