1. 首页
  2. 博客
  3. 如何在netbeans和eclipse中生成javadoc

如何在netbeans和eclipse中生成javadoc

Java源代码文档由JavaDoc项目表示，JavaDoc项目是描述代码中的类和方法的HTML页面的集合.

要生成Javadoc文档，我们需要一个来自JDK的工具 javadoc.exe，以及源代码中根据严格规则编写的注释.

因为在IDE（Integrated Development Environment，集成开发环境）NetBeans或Eclipse中开发Java项目更加高效，所以可以在所有这些开发环境中自动生成JavaDoc文档.

为了向我们展示如何在两个ide（NetBeans和Eclipse）中创建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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/**
* Java class example
* The class illustrates how to write comments used
* to generate JavaDoc documentation
*
* @author Catalin
* @version 2.00, 23 Dec 2010
*/
public class MyClass {
/**
*
* Simple method.
*
* The method prints a received message on the Console
*
* @param message String variable to be printed
* @see MyClass
* @deprecated
* @since version 1.00
*/
public void MyMethod(String message)
{
System.out.printf(message);
}
/**
*
* Simple method example.
* The method prints a received message on the Console
*
* @param message String variable to be printed
* @since version 1.00
*/
public void printMessage(String message)
{
System.out.printf(message);
}
/**
*
* Simple method example.
*
* The methods adds 2 numbers and return the result
*
* @param val1 the first value
* @param val2 the second value
* @return sum between val1 and val2
* @since version 2.00
*/
public int add(int val1, int val2)
{
return val1+val2;
}
}

如何在Netbeans中生成JavaDoc

  1. 在NetBeans中打开项目

  2. 在Projects面板中，右击project name打开上下文菜单，选择 Generate JavaDoc；
    另一个方法是使用菜单选项 Run–>Generate JavaDoc

  3. 这个项目的JavaDoc文档是在项目子文件夹 dist/JavaDoc中自动生成的.

如何在Eclipse Helios中生成JavaDoc

  1. 打开Eclipse项目

  2. 选择 项目–>生成JavaDoc

在Eclipse中生成JavaDoc

  1. 在向导的第一步中，可以定义以下设置：

3.1 javadoc.exe文件来自JDK的工具；

3.2 生成JavaDoc的项目资源；

3.3 基于其可见性生成JavaDoc的类和方法；

3.4 JavaDoc的位置（默认情况下，它将放在项目位置的doc文件夹中）

  1. 在第二步中，我们可以设置：

4.1文件结构；

4.2待处理的JavaDoc标签；

4.3文件中应包括的项目中使用的其他资源（档案、项目）；

4.4文件的另一个CSS样式表；

  1. 在最后一步，我们可以将设置保存在Ant脚本中以备将来使用.

  2. 在这些设置之后，文档将自动生成。

原文链接：https://codingdict.com/

热门标签