利用javadoc制作说明文档

利用javadoc制作说明文档，是通过文档注释来实现的。

文档注释中的一些特殊标示是能够被javadoc工具识别的，如：

用以描述类的：@author、@version

用以描述属性的：@param、@return

这些都是常用的，在eclipse中都是自动完成的。

注意：要制作文档的类一定要是public的，私有的类和属性是不能暴露出来的。

例：

/**
这是一个练习类，用来练习javadoc制作java说明文档。
@author sawy
@version v1.1
*/

public class Test
{
    /**
    @param x 这个参数是加数
    @param y 这个参数是被加数
    @return 返回加法运算结果
   */
    public static int add (int x , int y)
    {
       return x+y;
     }
    /**
     @param x 这个参数是减数
     @param y 这个参数是被减数
     @return 返回减法运算结果
     */
     public static int sub (int x , int y)
     {
       return x-y;
     }
}

最后通过javadoc命令来完成说明文档的提取。

javadoc -d . Test.java      --> -d用来指示要存放说明文档的目录。