.javadoc可以根据项目代码的注释(当然是规范化的)自动生成HTML格式的API文档。
三种注释类型(注释必须紧贴着注释体,不然javadoc会忽略):
类注释
变量注释
方法注释
书写格式:
/** <-->
* ........
* @XXX <-->
*/
参数说明=====================
javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明
@author 作者名
@version 版本号
其中,@author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次,只有第一次有效
使用 @param、@return 和 @exception 说明方法
这三个标记都是只用于方法的。@param 描述方法的参数,@return 描述方法的返回值,@exception 描述方法可能抛出的异常。它们的句法如下:
@param 参数名 参数说明
@return 返回值说明
@exception 异常类名 说明
==============================================
参数说明:
@see 生成文档中的“参见xx 的条目”的超链接,后边可以加上:“类名”、“完整类名”、“完整类名#方法”。可用于:类、方法、变量注释。
@param 参数的说明。可用于:方法注释。
@return 返回值的说明。可用于:方法注释。
@exception 可能抛出异常的说明。可用于:方法注释。
@version 版本信息。可用于:类注释。
@author 作者名。可用于:类注释。
@deprecated 对类或方法的说明 该类或方法不建议使用,引起不推荐使用的警告
@note 表示注解,暴露给源码阅读者的文档
@remark 表示评论,暴露给客户程序员的文档
@since 表示从那个版本起开始有了这个函数
@see 表示交叉参考
javadoc命令:
javadoc [options] [packagenames] [sourcefiles]
-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员 (缺省)
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
-d 输出文件的目标目录
-version 包含 @version 段
-author 包含 @author 段
-splitindex 将索引分为每个字母对应一个文件
@interface
它用于定义新的注释类型(annotation type)。新建一个注释类型看起来和定义一Interface 没有什么两样,
MyTag.java用于新建一个用户自定义标签,代码如下,
================================================================================
package tiger.annotation;
/**
* 用户自定义标签??MyTag
*/
public @interface MyTag { }
定义了一个tag之后,我们就可以在任何java文件中使用这个tag了,
import tiger.annotation.MyTag;
public class TagTest{
@MyTag
public void testTag(){
}
}
===============================================================================
注释类型还可以有成员变量,
==============================================================================
package tiger.annotation;
/**
* 用户自定义标签??带有成员变量的MyTag
*/
public @interface MyTag {
String name();
int age();
}
=============================================================================
然后我们可以这么使用这个标签,
@MyTag(name="MyTag",age=1)
public void testTag(){
}
使用标签最终是为了帮助开发人员提取注释信息,然后根据不同需求做进一步处理,下面我们来看看如何获取注释信息。
=============================================================================
import java.lang.annotation.Annotation;
import tiger.annotation.MyTag;
public class TagTest{
@MyTag(name="MyTag",age=1)
public void test(){
}
public static void main(String[] args){
TagTest tt = new TagTest();
try {
Annotation[] annotation =tt.getClass().getMethod("test").getAnnotations();
for (Annotation tag :annotation) {
System.out.println("Tag is:" + tag);
System.out.println("tag.name()" + ((MyTag)tag).name());
System.out.println("tag.age()" + ((MyTag)(tag)).age());
}
} catch(NoSuchMethodException e) {
e.printStackTrace();
}
}
}
===============================================================================
需要注意的一点是,在执行这段代码之前我们还有一点小工作要做,还需要给我们的自定义标签MyTag加上一个说明标签,@ Retention, 表明注释信息将可以在运行时刻通过反射机制得到。如果不加入这个标签,上面的代码将没有任何输出。修改以后的MyTag如下,
================================================================================
/**
* 用户自定义标签??带有成员变量的MyTag
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTag {
String name();
int age();
}
================================================================================
然后我们执行TagTest可以得到输出如下,
Tag is:@tiger.annotation.MyTag(name=MyTag, age=1)
tag.name()MyTag
tag.age()1
好了,Tiger新的注释语法基本用法就这么简单,基本用法虽然简单,但是获取注释信息之后如何处理确很值得推敲,我们可以用他们来做一些语法检查,文件相关性检查,进行各种统计等等
分享到:
相关推荐
也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。 Java中有三种注释方法://单行注释、/多行注释/和/文档注释/,其中第三种专为JavaDoc设计...
JavaDoc文档是Java编程语言中一个非常重要的工具,它用于生成关于Java源代码的API文档。这个工具通过解析源代码中的注释(Javadoc注释),生成易于阅读和理解的HTML格式文档,使得开发者能够方便地了解类、接口、...
JavaDoc是一种在Java编程语言中创建API文档的标准工具。它从源代码中的特殊注释中提取信息,并生成易于阅读的HTML格式文档,使得其他开发者能够理解并使用你的代码。本压缩包包含了一份非常标准的JavaDoc注释文档,...
Eclipse中自动生成Javadoc的方法,以及一些标签的含义
"liblinphone-android-javadoc文档" 指的是针对liblinphone Android版的Java开发文档。liblinphone是一个开源的SIP VoIP客户端库,它支持多种平台,包括Android。Javadoc是Java编程语言的一种文档生成工具,用于自动...
为了使生成的Javadoc文档尽可能丰富和有用,你需要在源代码中使用特定的Javadoc标签进行注释。例如: ```java /** * This is a sample class. * @author Your Name * @version 1.0 */ public class SampleClass...
### javadoc文档详解 #### 一、javadoc简介与意义 在软件开发过程中,良好的文档对于项目的维护和发展至关重要。javadoc是Java平台提供的一种官方文档生成工具,它可以帮助开发者生成一套详尽的API文档。通过在源...
JavaDoc 标签是JavaDoc工具用来解析和构建文档的关键元素,它们提供了关于类、方法、变量等详细信息的结构化描述。下面我们将详细介绍这些标签及其用途。 1. **`@author`**:这个标签用于标识一个类的作者。例如: ...
总结,使用Eclipse生成Javadoc文档是Java开发中不可或缺的一部分,它有助于提升代码的可读性和维护性。通过合理利用Javadoc注释和Eclipse的导出功能,可以轻松生成专业且详尽的API文档,促进团队间的有效合作。
Javadoc是一种在Java编程语言中用于生成API文档的工具,它能够自动提取源代码中的注释,形成清晰、结构化的文档,方便开发者理解和使用代码库。本文将深入探讨Javadoc的基本概念、语法、以及如何在Android Studio、...
要生成JavaDoc文档,你需要在命令行中运行JavaDoc工具,指定源代码目录和输出目录。例如: ``` javadoc -d doc -sourcepath src com.example.* ``` 这将把`src`目录下的`com.example`包及其子包中的所有Java...
除了基本的`/**...*/`注释形式,JavaDoc还支持以下特殊标签: - `@param` 描述方法参数。 - `@return` 描述方法返回值。 - `@throws` 或 `@exception` 描述方法可能抛出的异常。 - `@author` 记录代码作者。 - `@...
要生成JavaDoc文档,可以使用命令行的`javadoc`命令,或者通过IDE(如Eclipse、IntelliJ IDEA)内置的功能。例如,在命令行中,进入包含Java源代码的目录并运行: ```bash javadoc -d doc -sourcepath src ...
也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。 Java中有三种注释方法://单行注释、/多行注释/和/文档注释/,其中第三种专为JavaDoc设计,...
- 最后,点击“Finish”按钮,Eclipse将开始处理你的源代码并生成Javadoc文档。这可能需要一段时间,具体取决于你的项目大小。 生成的Javadoc文件会按照HTML格式保存在你指定的输出目录中,你可以通过浏览器查看...
标签:jcraft、jsch、中英对照文档、jar包、java; 使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用...
标签:aws-s3-1.8.1-javadoc.jar,aws,s3,1.8.1,javadoc,jar包下载,依赖包
该指南涵盖了 JavaDoc 的基本概念、使用方法、语法规则、标签、注释、文档生成等方面的内容。 JavaDoc 概念 JavaDoc 是一款文档生成工具,用于生成 Java 类、接口、枚举、注释、字段、方法、构造函数等元素的文档...
【标题】"easy-javadoc本项目是IntelliJ IDEA的插件"揭示了这是一个专为IntelliJ IDEA设计的插件,它的主要功能是简化Java开发者生成Javadoc文档注释的过程。在Java编程中,Javadoc是一种标准工具,用于生成关于类、...
通过遵循标准的Javadoc注释格式,如使用`@param`, `@return`, `@throws`, `@author`, `@version`等标签,可以提高文档的结构化和可读性。 总结来说,MyEclipse导出Javadoc的步骤包括选择项目、选择导出选项、配置...