由于文档注释是用于生成API文档的,而API文档主要用于说明类,方法,属性的功能。因此javadoc工具只处理文档源文件在类、接口、方法、属性、构造器和内部类之前的注释,忽略其他地方的文档注释。而且javadoc工具默认只处理以public和protected修饰的类、接口、方法、属性、构造器之前的文档注释。
文档注释以斜线后紧跟两个星号开始(/**),以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。
特别注意,一定要对处于多个包下的源文件来生成API文档时,才有概述页面
具体如下:
第一个测试类:
package lee;
/**
*Description:
*<br/>Copyright (c),2005-2008,Yeeku.H.lee
<br/>This program is protected by copyright laws;
*<br/>Program Name:
*<br/>Dte:
*@author Yeeku.H.Lee kongyeeku@163.com
*@version 1.0
*/
public class TestJavadoc{
/**
*简单测试属性
*/
protected String name;
/**
*主方法,程序的入口
*/
public static void main(String[] args){
System.out.println("Hello World!");
}
}
第二个测试类:
package yeeku;
/**
*Description:
*<br/>Copyright (c),2005-2008,Yeeku.H.lee
<br/>This program is protected by copyright laws;
*<br/>Program Name:
*<br/>Dte:
*@author Yeeku.H.Lee kongyeeku@163.com
*@version 1.0
*/
public class Test{
/**
*简单测试属性
*/
public int age;
/**
*Test类的测试构造器
*/
public Test(){
}
}
javadoc命令的基本用法如下:
javadoc 选项 java源文件/包。
javadoc命令可对源文件,包来生成API文档,在上面的预防格式中,java源文件可以支持通配符,例如使用*.java来代表当前路径下所有java源文件。javadoc的常用选项如下:
-d <directory>: 该选项指定一个路径,用于将生成的API文档放到指定目录下。
-windowtitle <text>:该选项指定一个字符串,用于设置API文档的浏览器窗口标题。
doctitle <html-code>:该选项指定一个HTML格式的文本,用于指定概述页面标题。
-header <html-code>:该选项指定一个HTML格式的文本,包含每个页面的页眉。
命令行窗口执行以上两个java程序生成API文档:
javadoc -d apidoc -windowtitle 测试 -doctitle 学习javadoc -header 自定义类Test *.java
分享到:
相关推荐
JavaDoc生成API文档(powernode CD2207)(内含教学视频+源代码) 1.1 JavaDoc概述 1.2 文档注释的格式 1.3 IDEA生成API文档 JavaDoc是Java自带的一种工具,其可以从程序源代码中抽取类、方法、属性等注释形成一个和源...
JavaDoc生成API文档(powernode document)(内含源代码和导出的文档) 1.1 JavaDoc概述 1.2 文档注释的格式 1.3 IDEA生成API文档 vaDoc是Java自带的一种工具,其可以从程序源代码中抽取类、方法、属性等注释形成一...
Eclipse中自动生成Javadoc的方法,以及一些标签的含义
使用Javadoc生成Java API文档的方法
非常标准的javadoc注释文档,值得试用
最新版本 JDK9 API Javadoc 帮助文档 CHM JAVA9开发手册
欢迎下载浏览
Javadoc帮助文档的生成,并备注了代码,可以参考注释的书写格式。
maven-javadoc-plugin 插件 解决中文乱码 和注解 时间问题, 包括eclipse.ini设置、pom.xml设置、maven build GBK设置、eclipse注释设置、eclipse注释模版(可导入)。
本项目是IntelliJ IDEA的插件,能帮助java开发者自动生成javadoc文档注释
XStream 1.4.8 api javadoc 支持目录 索引 搜索
JavaDoc工具 解析Java源码注释,生成api文档、接口文档
Maven插件,用于从JAX-RS和Javadoc注释生成Swagger 这个Maven插件正在为基于JAX-RS的Java服务器生成Swagger API文档。 JAX-RS批注中未包含的其他信息放置在Javadoc注释中。 例 此处提供了一个使用javadoc2swagger-...
用javadoc命令生成api帮助文档,如果要学习的话,少了帮助文档哪能行,于是就用javadoc命令自己制作了一个。
JMS1.1 API JAVADOC 中文版+英文版,chm文件 真正的API中文版,而不是JMS规范
使用Eclipse生成javadoc文档的方法
对于Javadoc的自动生成网住文档的具体使用方法
hibernate@注解方式配置实体类时,利用javadoc接口生成数据库表及字段的注释说明,支持oracle、sqlserver、db2、mysql数据库。因用到java\lib\tools.jar,需要将该jar放入工程lib下(或者tomcat\lib下、或加入...
非常经典的javadoc注释文档,让你的代码一目了然
MyBatis3.2.8中文开发文档,javadoc,API,解压开,直接打开index.html