Java文档

标签 java documentation javadoc

<分区>

我无法为这段代码创建文档,我认为我的 javadoc 是不对的,我读过它但不明白,任何人都可以通过 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

最佳答案

在您的情况下,您需要提供文件名而不是包名。

javadoc abc.java

然后没有源文件错误信息就会消失。 no public classes 错误消息仍然存在 - 在您的类声明之前添加 public。或者,您可以将 -package-private 标志传递给 Javadoc 以包含非公共(public)类。

然后将文档注释直接移到您要注释的声明之前:

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

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

}

关于Java文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/6524816/

相关文章:

java - Android Studio 中相对布局问题中 Button 顶部的进度条

documentation - 如何在不更改默认安装文件的情况下修改 SandcaSTLe 演示样式

java - Maven JavaDoc 两次列出类

c# - Doxygen 并将属性值添加到输出文档

c# - 如何记录在 C# 中引发一般异常的方法?

java - 有没有办法让java eclipse格式化程序不对齐@param描述?

android - 如何为android项目生成javadoc

java - 如何从命令行运行单个 gradle 任务

java - 获取 java.lang.NoClassDefFoundError : javax/net/SocketFactory while sending email using mail. jar

java - java中的伪代码?