房上的猫:JavaDoc注释

//这是一个注释
/*
  *这是一个演示程序
  */
/**
   *@这是JavaDoc注释。
  */

JavaDoc注释

   背景:

      javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。

  语法规则:      (1)JavaDoc注释以"/**"开头,以"*/"结尾      (2)每个注释包含一些描述的文本及若干个JavaDoc标签      (3)JavaDoc标签一般以"@"为前缀

  常用的JavaDoc标签:

标签

说明

JDK 1.1 doclet

标准doclet

标签类型

@author 作者

作者标识

包、 类、接口

@version 版本号

版本号

包、 类、接口

@param 参数名 描述

方法的入参名及描述信息,如入参有特别要求,可在此注释。

构造函数、 方法

@return 描述

对函数返回值的注释

方法

@deprecated 过期文本

标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。

包、类、接口、值域、构造函数、 方法

@throws异常类名

构造函数或方法所会抛出的异常。

构造函数、 方法

@exception 异常类名

同@throws。

构造函数、 方法

@see 引用

查看相关内容,如类、方法、变量等。

包、类、接口、值域、构造函数、 方法

@since 描述文本

API在什么程序的什么版本后开发支持。

包、类、接口、值域、构造函数、 方法

{@link包.类#成员 标签}

链接到某个特定的成员对应的文档中。

包、类、接口、值域、构造函数、 方法

{@value}

当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。

√(JDK1.4)

静态值域

  此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标签,这里不再做介绍

  生成JavaDoc文档        (1)使用命令行方式生成

        使用命令行在目标文件所在目录输入javadoc +文件名.java。

命令格式:

Javadoc命令格式如下:
javadoc [选项] [软件包名称] [源文件]
其中选项有:
-overview <文件> 读取 HTML 文件的概述文档
-public 仅显示公共类和成员
-protected 显示受保护/公共类和成员(默认)
-package 显示软件包/受保护/公共类和成员
-private 显示所有类和成员
-help 显示命令行选项并退出
-doclet <类> 通过替代 doclet 生成输出
-docletpath <路径> 指定查找 doclet 类文件的位置
-sourcepath <路径列表> 指定查找源文件的位置
-classpath <路径列表> 指定查找用户类文件的位置
-exclude <软件包列表> 指定要排除的软件包的列表
-subpackages <子软件包列表> 指定要递归装入的子软件包
-breakiterator 使用 BreakIterator 计算第 1 句
-bootclasspath <路径列表> 覆盖引导类加载器所装入的类文件的位置
-source <版本> 提供与指定版本的源兼容性
-extdirs <目录列表> 覆盖安装的扩展目录的位置
-verbose 输出有关 Javadoc 正在执行的操作的消息
-locale <名称> 要使用的语言环境,例如 en_US 或 en_US_WIN
-encoding <名称> 源文件编码名称
-quiet 不显示状态消息
-J<标志> 直接将 <标志> 传递给运行时系统

       (2)使用MyEclipse工具生成           "File"-->"Export"弹出"导出"对话框,选择"java"菜单中的"JavaDoc"选项,提交(点击Next)-->指定生成doc文档的文件位置-->点击Fish-->找到生成的文件位置查看

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

扫码关注云+社区