Java文档注释

  文档注释是用于生成API文档,API主要用于说明类、方法、成员变量

  • javadoc工具 处理文档源文件在类、接口、方法、成员变量、构造器和内部类之前的注释,忽略其他地方的文档注释。而且javadoc工具默认只处理以public或protected修饰的类、接口、方法、成员变量、构造器和内部类之前的文档注释。
  • 如果开发者希望javadoc工具可以提取private修饰的内容,则可以使用javadoc工具是增加-private选项

javadoc命令的基本用法如下:

  javadoc 选项 Java源文件|包

java源文件可以支持通配符:

  如,使用*.java来代表当前路径下所有的java源文件。

javadoc 的常用选项:

  • -d<directory>: 该选项指定一个路径,用于生成的API文档存放到的指定目录下。
  • -windowtitle<text>: 该选项指定一个字符串,用于设置API文档的浏览器窗口标题。
  • -doctitle<html-code>:该选项指定一个HTML格式文本,用于指定概述页面的标题。 只有处于当个包下的源文件来生成API文档时,才有概述页面。
  • -header<html-code>:该选项指定一个HTML格式的文本,包含么个页面的页眉。
 javadoc -d apidoc -windowtitle 测试 -doctitle 学习 javadoc 工具的测试 API 文档 -header 我的类*Test.java                        

javadoc标记:

  • @author: 指定Java程序的作者。
  • @version:指定源文件的版本。
  • @deprecated:不推荐使用的方法。
  • @param: 方法的参数说明。
  • @return: 方法的返回值说明信息。
  • @see: "参见“,用于指定交叉参考的内容。
  • @exception:  抛出的异常的类型。
  • @throws: 抛出的异常,和@exception同义。

上面的标记的使用有位置限制的。

出现在类或者接口文档注释中的有@see、@deprecated、@author、@version等

可以出现在方法或者构造器文档注释的有@see、@deprecated、@param、@return、@throws、和@exception等

可以出现在成员变量的文档注释中的有@see和@deprecated等

时间: 01-11

Java文档注释的相关文章

Java 文档注释

Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息,并输出到HTML文件中. 说明注释,是你更加方面的记录你的程序的信息. javadoc 标签 javadoc工具软件识别以下标签: 标签 描述 示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @deprecated de

java文档注释主要使用方法

一.java包含哪些注释 1.//用于单行注释. 2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套. 3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句.这个也就是我们所知的文档注释 在命名控制台:使用命令行在目标文件所在目录输入javadoc +文件名.java. 二.文档注释的关键名词 /**<p>标记 用于 作用</p> * @author 类或方法 一般用于描述开放者 * @version 类 版本说明 * @see 对类.属性.

添加Java文档注释

一.在Eclipse中add javadoc comment的快捷键为: 快捷键为:ALT + SHIFT +J 二.Window-->Preferences-->General-->Keys;找到"add javadoc comment"更改自己喜欢的快捷键. 三.另外如果觉得注释也不爽时也可以改改,修改的方法有两种: 1.直接在eclipse给的模板下进行修改 打开eclipse Window-->Preferences-->Java-->Cod

静态的应用与文档注释

一.静态的应用一: 比如数组工具类: 每个应用程序中都有共性的功能,可以将这些功能进行抽取,独立封装以便复用 虽然可以通过建立ArrayTool的对象使用这些工具方法对数组进行操作 但是: 1.对象是用于封装数据的,可是ArrayTool对象并没封装特有数据(没有成员变量). 2.操作数组的每一个方法都没有用到ArrayTool对象中的特有数据 这时就考虑,让程序更严谨,是不需要对象的,可以将ArrayTool中的方法都定义成static的,直接用类名调用 将方法都静态后,可以方便于使用,但是该

[java基础]文档注释

转载自:http://blog.163.com/hui_san/blog/static/5710286720104191100389/ 前言 Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗? 1)// 注释一行   2)/* ...... */ 注释若干行 3)/** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /**   * .........   * .........   */ 这第三种注释有什么用?javado

java笔记------文档注释标记,String相关的API

常用的javadoc标记有以下几种: [email protected] 程序的作者说明 [email protected] 源文件的版本说明 [email protected] 方法的参数说明 [email protected] 不建议的使用方法 [email protected] 方法的返回值的说明信息 [email protected] 参见,用于指定参考内容 [email protected] 抛出的异常类型 [email protected] 抛出的异常 可以出现在类或者接口文档注释中

文档注释与多行注释的区别

多行注释与文档注释的区别: 多行注释的内容不能用于生成一个开发者文档, 而文档注释 的内容可以生产一个开发者文档. 使用javadoc开发工具即可生成一个开发者文档. javadoc工具的使用格式: javadoc -d 存放文档的路径 java的源文件 使用javadoc工具要注意细节: 1. 如果一个类需要使用javadoc工具生成一个软件的开发者文档,那么该类必须使用public修饰. 2. 文档注释注释的内容一般都是位于类或者方法的上面的. 写注释的规范:一般单行注释是位于代码的右侧,多

使用文档注释(javadoc)

相信作为Java程序猿,几乎每个人都使用过javac,Java这样的命令吧.想想我们平时使用的Java帮助文档(API),感觉挺好用的,其实它就是使用Java中的命令javadoc做成的.下面简单介绍一下这个命令是怎么使用的: 首先Java中用三种注释方式,要想使用javadoc生成文档并且将注释信息也添加进文档里面,就要是用这种方式: 1 /** 2 * 3 */ 其次就是注释信息应该放置的位置.1.对类的注释放在类申明之前;2.对方法的注释放在方法申明之前;下面举一个简单的例子: 1 pac

C# XML 文档注释文件格式

在编写 C# 代码时,只要在注释按照格式加入 XML 文档注释,例如: /// <summary> /// 这里是类的注释. /// </summary> public class MyClass { } 就可以通过设置项目的"属性->生成->输出->XML 文档文件",来为当前项目生成包含所有文档注释的 XML 文件.一般可用于 Visual Studio 的智能提示,或者利用 Sandcastle 等工具生成文档. 下面,我会介绍生成的 X