A. 如何生成javaAPI doc

基本原理是通过jdk\bin\javadoc.exe来生成的。

具体方法，有许多网页，博客可以参考。
比如
http://www.cnblogs.com/rollenholt/archive/2012/11/13/2767592.html
http://blog.csdn.net/leiming32/article/details/8215957
oracle也有官方文档。

B. java 开发接口后，有没有快速生成说明文档的方法

网页链接

参考这个链接

打开java代码，编写JavaDoc 注释，只有按照java的规范编写注释，才能很好的生成API文档，javadoc注释与普通注释的区别为多一个*（星号）。普通代码注释为/*XXX*/，而javadoc的注释为/**XXX*/

写好注释后

点击eclipse的【Project】菜单，选择【Generate JavaDoc】选项。

C. 如何用javadoc生成jdk api

注意：本经验使用的eclipse版本为
Eclipse Java EE IDE for Web Developers.
Version: Luna Service Release 1 (4.4.1)
Build id: 20140925-1800

打开java代码，编写JavaDoc 注释，只有按照java的规范编写注释，才能很好的生成API文档，javadoc注释与普通注释的区别为多一个*（星号）。普通代码注释为/*XXX*/，而javadoc的注释为/**XXX*/

javadoc注释要尽量写的详细，这样别人在没有源码的情况下才知道如何使用您的代码。

点击eclipse的【Project】菜单，选择【Generate JavaDoc】选项。

（1）选择您要生成JavaDoc的工程
（2）选择哪些级别的内容生成JavaDoc，默认为public，如果选择private则会全部内容都生成。
（3）选择doc的生成位置，默认为工程目录下，建议不要修改。
（5）点击【Next】按钮

（1）勾选Document Title，然后填写文档标题。
（2）点击【Next】按钮

（1）选择使用的jdk版本
（2）点击【Finish】按钮

可以看到控制台输出生成javadoc的信息。

项目下生成一个【doc】的目录，里面存放着javadoc文档。

打开doc目录，用浏览器打开index.html

可以看到一个完整的API文档、javadoc就生成了。

D. 如何导出java的api文档

  • 要知道API文档有很多版本，有英文版的，也有中文版的，而对于初学者，或者英语不好的同学，可以先看看中文版的！

  • 在文档的左侧，上一部分有很多java包，如果要查看每个包里都有哪些类，接口，直接点击就可以了。在左侧下面一部分会列出包下所有类，接口和其他的一些东西。

  • 若是单独想要查询某个方法、接口或类，可以利用索引，按照字母查询。

    例如，要查询pack()，这个方法的用法和作用。直接点击字母p，在下面就可以找到了。

  • 单击pack(),就可以查看到关于pack()的一些内容了！当然，也可以直接在左侧的索引里输入要找的内容进行查找。

E. java api接口文档生成工具有哪些 支持struts的

Java语言提供了一种强大的注释形式：文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释，然后使用javadoc工具来生成自己的API文档。文档注释以斜线后紧跟两个星号（/**）开始，以星号后紧跟一个斜线（*/）作为结尾，中间部分全部都是文档注释，会被提取到API文档中。自行搜索一下javadoc即可，示例如下：java">/***类描述**@author作者*@version版本*/publicclassDemoClass{/***内部属性：name*/privateStringname;/***Setter方法*@returnname*/publicStringgetName(){returnname;}/***Getter方法*@paramname*/publicvoidsetName(Stringname){this.name=name;}}

F. 如何使用javadoc命令生成api文档，文档注释

代码如下：

[java]view plain

  • /**

  • *计算器工具类

  • *

  • *@

  • *@versionV1.0

  • */

  • publicclassComputerUtil{

  • /*

  • *加法运算

  • *

  • *@parama加数a

  • *@paramb加数b

  • *@return返回两个整数的和

  • */

  • publicstaticintadd(inta,intb){

  • returna+b;

  • }

  • /**

  • *减法运算

  • *

  • *@parama被减数

  • *@paramb减数

  • *@return返回两个整数的差

  • */

  • publicstaticintsubtraction(inta,intb){

  • returna-b;

  • }

  • /**

  • *乘法运算

  • *

  • *@parama因数

  • *@paramb因数

  • *@return返回两个整数的乘积

  • */

  • (inta,intb){

  • returna*b;

  • }

  • /**

  • *除法运算

  • *

  • *@parama被除数

  • *@paramb除数

  • *@return返回两个整数的商

  • */

  • intdivision(inta,intb){

  • returna/b;

  • }

  • /**

  • *取余运算

  • *

  • *@parama被除数

  • *@paramb除数

  • *@return返回两个整数的相除后的余数

  • */

  • privateintresial(inta,intb){

  • returna%b;

  • }

  • }

    • 步骤：

    ①、打开DOS窗口；

    ②、定位到到该类的源文件所在文件夹；

    ③、输入命令：javadoc -d c:help -author -version ComputerUtil.java

    说明：-d：其后空一格，用来指定生成的帮助文档存放的位置；

    -author：用来指定生成的帮助文档必须显示该类的作者，如果没有这一命令则生成的帮助文档将不会显示作者；

    -version：用来指定生成的帮助文档必须显示该类的版本，如果没有这一命令则生成的帮助文档将不会显示版本；

    ④、点击回车键。

    结论：

    ①、Java中多行注释分为文档注释和非文档注释，只有文档注释所注释的内容才会出现在帮助文档中，非文档注释所注释的内容不会出现在帮助文档中（比如add方法，由于该方法的注释是非文档注释，所以注释内容没有生成到帮助文档中，只出现了该方法的一些信息）；

    ②、只有被public和protected修饰的方法添加的文档注释的注释内容才能出现在帮助文档中，所以division方法和resial方法尽管采用了文档注释，但注释内容和方法信息却没有出现在帮助文档中；

G. 怎么用javadoc生成api文档

javadoc -d myfill -autor -version api.java
myfill是创建的文档存放位置，名字随便起，-autor是作者名 -version是版本号 api.java 是java文档的路径内 如果有包要带上包名，这容里我创建了一个java学习群前面是六六5中间是六一7后边是150，想学好的可以进来。

H. java api 接口怎么编写

Java语言提供了一种强大的注释形式：文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释，然后使用javadoc工具来生成自己的API文档。

文档注释以斜线后紧跟两个星号（/**）开始，以星号后紧跟一个斜线（*/）作为结尾，中间部分全部都是文档注释，会被提取到API文档中。

自行搜索一下javadoc即可，示例如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

/**
* 类描述
*
* @author 作者
* @version 版本
*/
public class DemoClass {
/**
* 内部属性：name
*/
private String name;

/**
* Setter方法
* @return name
*/
public String getName() {
return name;
}

/**
* Getter方法
* @param name
*/
public void setName(String name) {
this.name = name;
}

}

I. 我用javadoc命令生成api文档，为什么用包生成的，和用文件生成的，里面的构造器的注释不一样呢

你的这种情况我没试过,我一般都是用eclipse自带的导出api

/***/这种格式,都是会被javadoc获取的
我猜想,你第一次是多了对包的注释吧
第二次只是对类的注释