📜  java 创建API文档

📅  最后修改于: 2020-09-24 05:40:27             🧑  作者: Mango

创建API文档| javadoc工具

我们可以借助javadoc工具在Java中创建文档api。在Java文件中,我们必须使用文档注释/**…*/来发布有关类,方法,构造函数,字段等的信息。

让我们看一下包含文档注释的简单类。

"package com.abc;  
/** This class is a user-defined class that contains one methods cube.*/  
public class M{  
  /** The cube method prints cube of the given number */  
public static void  cube(int n){System.out.println(n*n*n);}  
}  

要创建文档API,您需要使用javadoc工具,后跟Java文件名。无需编译javafile。

在命令提示符下,您需要编写:

javadoc M.java

生成文档api。现在,将创建许多html文件。打开index.html文件以获取有关类的信息。