java如何使用javadoc

Question

我有一个关于javadocs的非常基本的问题——我提前道歉，我对这个话题完全不熟悉，在谷歌上找不到答案

我用java下载了一个特定的implementation，并在Eclipse中导入了下载的项目。在我需要的文件中，我发现了我不熟悉的语法，例如，函数前面出现了以下内容：

/**
 * Default implementation of the MarkovDecisionProcess<S, A> interface.
 * 
 * @param <S>
 *            the state type.
 */

事实证明，这种语法被称为javadoc（？）。我的问题是：我如何使用这个javadoc东西？我应该将项目导入到单独的项目中，还是编辑给定的代码？如果是的话——例如，如何修改@param语法

Answer 1

语法如下：

@param      value    the explanation of the value.

这意味着你的类有一个参数值。当你试图理解这个类的功能时，你不会真正使用这个代码。它们就像comment一样，但是您可以使用该代码在Eclipse中自动生成文档。Eclipse将读取这些注释并将其格式化为html文件

这是All the ways to generate javadoc in Eclipse

Answer 2

既然已经有一些很好的答案描述了JavaDoc的使用，我就不重复了，并且简单地说：JavaDoc是用于代码文档的。 这意味着它对所描述的代码没有任何功能影响。它只是描述了方法、类、常量等的作用。这样做的好处是，您不必通过代码来了解方法的用途以及返回的具体内容。我觉得这节省了很多时间

至于更改方法的参数：您只需更改代码，就像在没有javaDoc的情况下通常所做的那样。为了防止文档中说的不是代码实际做的事情，您需要根据对方法的更改来更改javaDoc。JavaDoc通常是这样的：

    /**
     * Creates an instance of foo.
     * 
     * @param bar
     *            the size of bar
     * @return the created foo
     */
     public Foo createFoo(Bar bar)
     {
        //do something
        return new Foo(bar);
     }

如您所见，方法描述后面是bar的参数描述，然后是方法返回的描述

要添加新参数，只需在javaDoc中添加一个新的@param：

    /**
     * Creates an instance of foo.
     * 
     * @param bar
     *            the size of bar
     * @param foobar
     *            <describe here what foobar is>
     * @return the created foo
     */
     public Foo createFoo(Bar bar, Foobar foobar)
     {
        //do something
        return new Foo(bar);
     }

Answer 3

Javadocs提供有关代码的信息。Eclipse（可能还有其他所有IDE）都使用它来提供有关当前正在编写的代码的信息

这只是我开始输入System.cu...时打开的一个小窗口的图片。唯一与之匹配的函数是currentTimeMillis，因此该函数被选中。右边是另一个包含javadoc的小窗口。它可以向你展示很多关于函数的功能，有时甚至是它如何工作的信息。它还可以为您提供有关每个参数（这就是@param）的信息、返回值、可能引发的任何异常以及相关函数/类等