IDEA/eclipse生成API文档

什么是api?

   Application Programming Intergace 应用程序编程接口

 

一些常用的标签

 

       @see  : 引用其他类

      @see标签允许用户引用其他类文档,javadoc会在其生成Html文件中,通过@see标签链接到其他文档.(javadoc不会检查这个@see后引用的超链接是否有效).

 

    @version 使用格式如下

@version version-information

    version-information 可以是任何你认为适合包含在版本说明的重要信息,如果javado命令执行"-version"标记,那么就从生成的HTML文档中特博尔提取出版本信息.

 

@Parm 该标签用于方法文档中,形式如下

@Param parameter-name description

  其中parameter-name 是方法的参数列表中的标识符,description 是可延续数行的文本,终止于新的文档标签出现之前.可以使用任意多个这种标签,大约每个参数都有一个这样的标签.

 

@author 该标签格式如下

@author author-information

其中,author-information 一看便知道就是你的名字,但是也可以包括电子邮件地址或者其他任何事宜的信息.如果javadoc命令使用-author标记,那么就从生成的HTML文档中特别提取作者信息.

 

@return 该方法用于方法文档,格式如下

@return description

其中description 用来描述返回值的含义,可以延续数行.

 

@throws 异常格式如下

@throws fully-qualified-class-name description

 

其中fully-qualified-class-name 给出一个异常类的无歧义的名字,而该异常类在别处定义.description ( 同样延续数行),告诉你为什么此特殊类型的异常会在方法调用中出现.

 

比如我们想把项目的注释文档打印到HTML上便于查看可以这样

 

 

 

     

 

传入javaDoc参数 -encoding UTF-8 -charset UTF-8 -windowtitle "文档HTML页面标签的标题" -link http://docs.Oracle.com/javase/7/docs/api

 

等待系统生成页面;如下生成完成

 

 

 

eclipse生成api文档的方法