java文档

Question

我无法为此代码创建文档，我认为我对javadoc的命令不正确，我读到它但不明白，任何人都可以通过javadoc命令更正

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

然后无源文件错误消息将消失。 no public classes 错误消息仍然存在 - 在您的类声明之前添加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文件），而不是类名。

Answer 3

这是旧的，我知道，但我找到了一个适合我的解决方案。它不是基于包的，但我花了很长时间才弄明白，所以我想我会分享它：

javadoc -private *.java

私人选项是关键所在。