Javadoc详解(二)
来源:互联网 发布:visio网络图标库vss 编辑:程序博客网 时间:2024/05/17 00:14
Javadoc是用来干什么的?
1. javadoc是生成一个java api文档生成工具。存在于jdk安装目录下的bin目录中。
2. Javadoc是Oracle公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
简单的说,Java中有三种注释方法:
1. //被注释语句
2. /*被注释语句*/
3. /**被注释语句*/
其中第三种专为JavaDoc设计,可以被JDK内置的JavaDoc工具支持和处理。
生成的api文档详解:
3.help-doc.html:对doc目录文件做说明,解释每个文件都是干嘛的,如果不明白各个目录是干嘛的,有必要先读此文档。
4..class-use文件夹下的html和 底下相同文件名的html内容不一样 ?
class-use文件夹下的IDCard.html: 描述“此类与工程中其他类的关系”:整个工程中用到IDCard类的地方,包括方法的返回值是此类的对象,方法中的参数是此类的对象等等。
底下同名的IDCard.html:描述“类本身”的属性:比如对此类的变量、方法等一个整体的描述。
5. package-frame.html ,frame:框架
package-summary.html, summary:摘要
以上是对包的描述。
6.index-files文件夹
index-1.html
index-2.html
index-3.html
index-4.html
index-5.html 。。。
等等,以上每个html都对应A-Z或者a-z中的一个字母,然后在罗列以此字母开头的变量和方法(整个工程),按顺序从A-Z。比如index-1.html,对应字母A,那么index-1.html中显示的是整个工程中以字母A或者a开头的变量和方法;如何工程中没有以A或者a开头的,就从B开始。
7.allclasses-frame.html 和 allclasses-noframe.html的区别:???
8.constant-values.html:常量
9.deprecated-list.html: deprecated:过时的
10.package-list: 列出了所有的包名
11.
- Javadoc详解(二)
- Java Javadoc注释详解
- JavaDoc生成API详解
- JAVADOC注释详解
- 利用javadoc定制自己的接口文档(二)
- JDK常用命令选项详解(javac, java, javadoc)
- javadoc详解以及注释规范
- JavaDoc
- JavaDoc
- Javadoc
- javadoc
- javadoc
- javadoc
- JAVADOC
- JavaDoc
- javadoc
- Javadoc
- javadoc
- 【ASP.NET】验证控件
- ALSA声卡驱动中的DAPM详解之七:dapm事件机制(dapm event)
- Behavioral模式之Observer模式
- 透过IT大佬的高考专业选择,你的兄弟姐妹可以取得哪些“真经”?
- 设计模式学习之简单工厂+反射+配置文件
- Javadoc详解(二)
- SAT阅读词汇总结:语气限定词
- Behavioral模式之Iterator模式
- SmartGit的安装和使用
- 压缩游戏包大小的几个方法
- java.lang.UnsatisfiedLinkError: org.jblas.NativeBlas.dposv(CII[DII[DII)I
- 使用 Redis 实现分布式系统轻量级协调技术
- SDWebImage基础应用
- u-boot.lds分析