Question

我目前正在学习AP Java课程，我甚至无法理解“javadoc”到底是什么，到目前为止我所看到的只是在创建API时它是一种“不同”的评论方式所以程序员可以更好地阅读代码。。。

我是新手，我很感激任何起点，所以我至少可以抓住这个概念。

Answer 1

我在考虑如何描述它，但说实话，我认为SO Javadoc标签做得非常好：

Javadoc是一个可扩展的文档生成系统，可以读取 Java源代码中特殊格式的注释并生成编译文件。它通常用于生成API HTML网页形式的文档。

许多IDE还使用Javadoc来生成上下文API描述。 Javadocs可以在一个非常模糊的库和令人愉快的东西之间做出区分。

Javadocs，使用它们!!

Answer 2

每当您需要查找Java方法时，您都可以使用Google的方法名称并参考文档以查看其功能。好极了！

但是这些文档是如何实现的呢？如何生成这么多文档？是否有人雇用这样做？

好吧，每当你编写代码时，你需要使用注释在源文件中正确解释它。 /** */标记了评论块。现在，javadoc负责将这些注释解析为文档（它使这些注释中的HTML文件）。因此，只有javadoc被执行才被雇用。

以下是开始评论的示例：

/**
* Classname
* Version info
* Copyright notice
*/

但这不是全部。 javadoc非常强大。它允许您甚至在注释中编写基本HTML，然后解析HTML以提供适当的输出。 /** <html> */这就是为什么一些JacaDoc页面有表格的原因。这些是使用HTML

中的<td>和<tr>标记制作的

例如，

/**
   * First paragraph.
   * <p><ul>
   * <li>the first item
   * <li>the second item
   * <li>the third item
   * <ul><p>
   * Second paragraph.
   */

如果您希望javadoc与您的代码一起正常运行，请遵循Java代码约定：http://www.oracle.com/technetwork/java/codeconventions-150003.pdf如果您的代码符合约定，javadoc就可以轻松制作文档。

以下是撰写文档评论的官方Oracle指南：http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Answer 3

Javadoc是一个很像编译器的程序，它可以读取你的代码并删除它的某些部分，以便以html页面的形式创建一个（非常非常非常非常有用的）文档。您用于标准Java代码的API页面是使用Javadoc创建的。

在解析代码时，Javadocs会查找两件事：代码结构和Javadoc注释。代码结构只是代码本身。这用于构建页面的基本结构（即类名，字段，方法等）。 Javadoc注释是以/**而不是通常的/*开头的特殊注释。就常规java编译器而言，它没有任何区别。一旦进入Javadoc注释，您就可以使用html标记以及其他一些特殊语法来编写有关您引用的代码的特定方面的内容。您可以详细了解here

Answer 4

Javadoc是一个程序，它可以读取您的java文件并从中创建HTML文档。您可以通过在文档中添加注释然后调用它来使用它。

Answer 5

Sun将JavaDoc定义如下（http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html）：

Javadoc is a tool for generating API documentation in HTML format
from doc comments in source code

这些评论有一种广为人知的格式，称为“Javadoc”。您可以在http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

查看更多详情

什么是javadoc？

5 个答案: