猿教程 Logo

java 文档工具

我们可以在java中通过javadoc工具的帮助创建文档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文件以获取有关类的信息。


版权声明:本站所有教程均为本站原创或翻译,转载请注明出处,请尊重他人劳动果实。请记住本站地址:www.yuanjiaocheng.net (猿教程) 作者:卿文刚
本文标题: C#环境
本文地址:http://www.yuanjiaocheng.net/Java/creating-api-document.html