Java菜鸟学习笔记(3)--Java API 文档下载与文档注释的使用
为什么需要API文档?
1.Java提供了大量的基础类,再进行Java不可能把所有的类和方法记下来,因为遇到不确定不懂的地方,可以查看文档。
2.学会查看文档是一个程序员基本的素质。
使用流程
1.使用Oracle提供的Java在线API:
2.使用本地化的API DOC:
先去官方网站下载区:http://www.oracle.com/technetwork/java/javase/documentation/java-se-7-doc-download-435117.html
然后将下载厚的Jdk-7u25-apidocs.zip解压。
然后打开解压文件的 index.html就可以查看文档了
为什么要文档注释?
1.在团队合作中需要让其他成员看懂不同成员写的类,就可以制作API文档对类,package等进行描述和说明。
使用Javadoc文档注释
1.注释格式:
/**(内容) */
2.关键字列表
(在源码在可以注释的关键字列表)
@author 作者名
@version 版本标识
@parameter 参数及其意义
@since 最早使用该方法/类/接口的JDK版本
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@see reference
@override 重写
3.用法
javadoc [选项] [软件包名称] [源文件] [@file]