Java语言提供了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。
文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。
例子:
package com.yuchao.javadoc;
/**
* Description:
* <br/>Copyright(C),2011-2012,Jack.Yu
* <br/>This program is protected by copyright laws.
* <br/>Program Name:
* <br/>Data:
* @author Jack.Yu
* @version 1.0
*/
public class JavaDocClass {
/**
* 内部属性:name
*/
private String name;
/**
* Setter方法
* @return name
*/
public String getName() {
return name;
}
/**
* Getter方法
* @param name
*/
public void setName(String name) {
this.name = name;
}
}
javadoc命令可对源文件、包来生成API文档,常用选项有如下几个:
* -d<directory> 该选项指定一个路径,用于将生成API文档放到指定目录下
* -windowtitle<text>:该选项指定一个字符串,用于设置API文档的浏览器窗口标题
* doctitle<html-code>:该选项指定一个HTML格式的文本,用于指定概述页面的标题
* -header<html-code>:该选项指定一个HTML格式的文本,包含每个页面的页眉
例如对刚才的类生成API文档:
javadoc -d apidoc -windowtitle 实例 -doctitle 工具 -header 自定义类 JavaDoc*.java
除此之外,如果我们希望javadoc工具生成更详细的文档信息,例如为方法参数、方法返回值等生成详细的说明信息,则可以利用javadoc标记,有如下标记:
@author
@version
@deprecated
@param
@return
@see
@exception
@throws
分享到:
相关推荐
javadoc插件使用文档 javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。javadoc工具能够从下列对象中提取出消息:包、公共类、公共接口、公共可能受...
javadoc使用指南
Java 程序员都应该知道使用 JDK 开发,最好的帮助信息就来自 SUN 发布的 Java 文档。它分包、分类详细的提供了各方法、属性的帮助信息,具有详细的类树信息、索引信息等,并提供了许多相关类之间的关系,如继承、...
不过在运行过程中,它也使用了Java平台的环境变量classpath来确定类查找路径。这样当涉及类和内部类的有关描述时,是否正确地设置了classpath变量可能会影响到javadoc命令是否可以完全成功执行。
Java的自动文档成生功能非常的强大,完美地解决了代码注释在文档中的重用
使用Javadoc生成Java API文档的方法
使用Eclipse生成javadoc文档的方法
javadoc自定义的
idea easy_javadoc插件
Eclipse 与 Javadoc 配置解决方案 Eclipse 是一个功能强大且流行的集成开发环境(IDE),而 Javadoc 是 Java 官方提供的 API 文档生成工具。然而,在 Eclipse 中配置 Javadoc 并不是一件容易的事情。本文将详细介绍...
JMS API JAVADOC,详细解释方法的使用。
javadoc 注释规范 javadoc 是 Java 语言中的一种文档注释工具,用于生成 HTML 格式的文档。根据给定的文件信息,我们可以总结出...同时,javadoc 也可以用于生成 Java 项目的API 文档,方便其他开发者使用项目的接口。
redis-service 的JavaDoc
Javadoc的详细文档以及生成的方式(AndroidStudio、Eclipse、Javadoc命令)
4、本文插件已含全部帮助文档及package-list和index.html文件,不需要作任可加工,解压直接可以使用,到处下载,转码反编译,拆腾了一天,终于搞好了,希望只用你一分钟,本来想免积分分享,但是系统不允许,如果你...
Myeclipse导出Javadoc步骤
JavaDoc命令使用说明.pdf
JavaDoc写法规范 JavaDoc写法规范 JavaDoc写法规范
Eclipse中自动生成Javadoc的方法,以及一些标签的含义
中文JAVADOC中文JAVADOC