如何使用javadoc

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

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

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

---

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

Javadoc是一种元语言，允许自动生成HTML来记录项目

您可以在java.lang.Object上找到一个示例页面

关于如何使用javadoc工具的官方文档和指南如下

如果您使用的是IDE，那么可以预览javadoc

例如，在Eclipse中：

项目 生成javadoc。。。 这将打开一个向导。按Finish键后，您将在所选位置获得一个包含文档的小型站点。 首先，您可以通过/**…*/javadoc注释您的方法、变量和类声明Eclipse中的语法或Alt-Shift-J自动生成javadoc注释

@param和其他选项允许您指定文档的各个方面

---

您还可以在javadoc注释中使用原始HTML，并且在向导和命令行参数中都有许多javadoc生成参数可用

语法如下：

@param      value    the explanation of the value.

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

---

这是

Javadocs，它提供有关代码的信息。Eclipse和其他IDE可能都使用它来为您提供有关当前正在编写的代码的信息

---

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

因为已经有非常好的答案描述了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);
     }

---

嘿@Mena，谢谢你的回答。我要问的不是如何使用javadoc特性，比如HTML站点等等，而是——考虑到我下载了一个使用javadoc的代码，我该如何使用代码本身？例如：如何更改参数？@Cheshie我已经阅读了javadoc并找出了代码的用途。如果文档很少或没有文档，您将不得不调查源代码或在运行时对其进行调试。@Cheshie如何更改参数是什么意思？@Cheshie如果您需要再次更改方法的参数，为了安全起见，我建议通过IDE进行重构，您可能希望在javadoc中反映这些参数。您还可以为几乎所有您需要的内容自动生成一个javadoc草稿。它只是代码文档，没有什么能阻止它完全错误或与代码无关。它是用来帮助你理解你想要使用的代码的。你的问题没有多大意义。如果你下载了一个库，你通常不会修改它的javadoc，除非你参与。而且，除非您自己编写doclet，否则javadoc语法也是给定的：您不会更改它。另请参见：