为什么需要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]
分享到:
相关推荐
JAVA入门级笔记,满满当当适合刚学习用JAVA编程的程序员,不死记硬背靠理解走遍天下
java笔记-从菜鸟到j2se j2ee高手之路
java菜鸟学习第一步-java基础语法,学习一门语言先从语法开始学起,学好基础才能深入的学习编程
本人刚接触C#,练练手做了个小程序,美化效果比较差,对刚学OO思想想俺一样的菜鸟或许有那么点帮助,希望大家多多指教
20210808-银河证券-交通运输行业:菜鸟网络业绩表现持续向好,京东航空获批筹建.rar
20210808-银河证券-交通运输行业:菜鸟网络业绩表现持续向好,京东航空获批筹建.pdf
股市菜鸟必读----“笑傲股市”学习笔记.pdf
菜鸟入侵--利用资源搜索动画教程,内附有详细的使用说明 菜鸟入侵之利用资源篇 菜鸟在入侵的时候,如果能充分利用现有的资源,那将对自己的入侵起很大的
Java 面试笔记 这本书其实是我的一本笔记 (还在整理中). 我是也是刚找到工作. 这本笔记主要记录了我之前面试遇到的问题以及我在网上整理的一些资料 主要是面向 junior 级别的 就是我们这些小菜鸟啦 ~ --------------...
菜鸟成长手册2009——CPU-内存-硬盘篇 - 硬件知识精华菜鸟成长手册2009——CPU-内存-硬盘篇 - 硬件知识精华菜鸟成长手册2009——CPU-内存-硬盘篇 - 硬件知识精华菜鸟成长手册2009——CPU-内存-硬盘篇 - 硬件知识精华...
Java基础知识笔记详细版-菜鸟翻阅必备,可以作为坐地铁等公交的读物!
java 笔试面试题 Java 面试笔记 这本书其实是我的一本笔记 (还在整理中). 我是也是刚找到工作. 这本笔记主要记录了我之前面试遇到的问题以及我在网上整理的一些资料 主要是面向 junior 级别的 就是我们这些小菜鸟啦 ...
Python基础语法-菜鸟教程-函数⽤法:input()和raw_input() 1.input()和raw_input()⽤法 (1).input() 1)⽤法解释 def input(*args, **kwargs): # real signature unknown """ Read a string from standard input....
JAVA基础学习课件,菜鸟篇。零基础学Java(PPT)--java教学
java必备-菜鸟的最爱-正则表达式.docx
类、类属性、类方法的注释必须使用Javadoc规范 所有的抽象方法(包括接口中的方法)必须要用Javadoc注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。 所有的类都必须添加创建者和...
python-note 菜鸟学习笔记
java教程书籍
菜鸟的SAP自学学习笔记;对SAP初学者很有帮助喔!为了解决问题却也带来了相当大的收益,接触了那些以前不会考虑的问题领域,结识了一些之前根本想象不到的人,这些都是那么重珍贵。
看过方立勋老师的课程之后 做的一点小笔记 以后拿出来复习复习 不对之处 请见谅 本人只是默默的一只菜鸟