5

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

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

4

5 回答 5

6

我正在考虑如何描述它，但老实说，我认为 SOJavadoc标签做得很好：

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

许多 IDE 还使用 Javadocs 来生成上下文 API 描述。Javadocs 可以在极其晦涩难懂的库和令人愉悦使用的库之间产生差异。

Javadocs，使用它们！

于 2013-10-04T02:10:24.410 回答
6

每当您需要查找 Java 方法时，您可以在 Google 上搜索该方法的名称并参考文档以了解它的作用。伟大的 ！

但是这些文档是如何到位的呢？这么多文件是怎么产生的？有人雇来做那件事吗？

好吧，每当您编写代码时，您都需要使用注释在源文件中正确解释它。/** */标记注释块。现在，javadoc负责将这些注释解析为文档（它从这些注释中生成 HTML 文件）。所以，没有人被雇用只是javadoc被处决。

这是开始评论的示例： 

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

但这还不是全部。javadoc非常强大。它甚至允许您在评论中编写基本的 HTML，然后解析 HTML 以提供正确的输出。/** <html> */这就是为什么一些 JacaDoc 页面有表格的原因。这些是使用HTML 中的<td>and标记制作的<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

于 2013-10-04T02:32:01.063 回答
1

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

于 2013-10-04T02:04:44.020 回答
1

Javadoc 是一个类似于编译器的程序，它读取您的代码并提取其中的某些部分，以便以 html 页面的形式创建（非常非常非常非常）有用的文档。您用于标准 java 代码的API页面是使用 Javadoc 制作的。

在解析代码时，Javadocs 会查找两件事：代码结构和 Javadoc 注释。代码结构就是代码本身。它用于构建页面的基本结构（即类名、字段、方法等）。Javadoc 注释是特殊的注释，以/**代替通常的开头。/*就常规的 java 编译器而言，它没有任何区别。一旦在 Javadoc 注释中，您就可以写出所引用代码的特定方面，并且能够使用 html 标记以及其他一些特殊语法。你可以在这里了解更多

于 2013-10-04T02:08:44.933 回答
0

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查看更多详细信息

于 2013-10-04T02:15:49.800 回答