java文档

Question

我无法为这段代码创建文档,我想我的javadoc的coomad是不对的,我读到它但不明白,任何人都可以通过javadoc cammand纠正

class abc
{/** documentaion line 1
*
* */
public static void main(String a[])
{/** documentaion line 2
*
* */
System.out.println("documentation");
}
}

Error:
C:\Program Files\Java\jdk1.6.0\bin>javac abc.java

C:\Program Files\Java\jdk1.6.0\bin>java abc
documentation

C:\Program Files\Java\jdk1.6.0\bin>javadoc abc
Loading source files for package abc...
javadoc: warning - No source files for package abc
Constructing Javadoc information...
javadoc: warning - No source files for package abc
javadoc: error - No public or protected classes found to document.
1 error
2 warnings

Answer 1

在您的情况下,您可能希望提供文件名而不是包名.

javadoc abc.java

然后无源文件错误消息将消失.在没有公共课的错误消息依然存在-增加public你的类声明之前.或者,您也可以将-package或-private标记传递给Javadoc以包含非公共类.

然后在要注释的声明之前直接移动文档注释:

/**
 * class documentation here
 */
public class abc
{

    /** 
     * method documentation here 
     */
    public static void main(String a[])
    {
      /**
       * this will be ignored.
       */
       System.out.println("documentation");
    }

}

Answer 2

正如错误消息明确指出的那样，Javadoc 为类和方法（从包外部可见的成员）创建public文档protected。

你没有。

另外，Javadoc 采用包（文件夹或 JAR 文件），而不是类名。