看不懂Javadoc是什么
Can't understand what Javadoc is
我不明白 'Javadoc' 是什么。
我首先想知道 /** */
和 /* */
评论之间的区别。
当我在这里看到答案时,它在 java 中说了一些关于 HTML 和 APIs 的内容。这完全令人困惑,我什么也听不懂。我只是Java的初学者,所以请帮助我...
当我同时使用它们时,我看到绝对没有区别。编译器在执行时忽略了这两条多行注释。
编译器会忽略这两个注释,是的。编译器所做的事情没有区别。
不同之处在于,您可以使用 Javadoc 工具将 Javadoc 注释(而非普通注释)转换为 this 之类的文档。 (许多 IDE,如 Eclipse 或 IntelliJ,也将以这种格式显示文档,例如,当您将鼠标悬停在您正在调用的方法上时。)
编译为 class 时,普通注释会被删除。
Javadoc 不会像常规注释那样保留在代码中,可用于自动生成 HTML 文档,您可以发布这些文档以供人们理解您的 API。
Javadoc 示例:
https://docs.javacord.org/api/v/3.4.0/
Javadoc 与编译代码或任何其他运行时行为无关。
在那里,程序员可以对 类、变量和方法进行注释。全部 in-place,不需要外部评论或文件。
当你有像 Eclipse 或 IntelliJ 这样的 IDE 时,当你将鼠标悬停在其他地方的方法调用上时,它会显示这些注释。
Javadoc也可以从源代码中读取(.java类)编译成HTML页,就像所有主要的Java 文档是。
看看这个,这是一个很好的概述:https://www.baeldung.com/javadoc
我不明白 'Javadoc' 是什么。
我首先想知道 /** */
和 /* */
评论之间的区别。
当我在这里看到答案时,它在 java 中说了一些关于 HTML 和 APIs 的内容。这完全令人困惑,我什么也听不懂。我只是Java的初学者,所以请帮助我...
当我同时使用它们时,我看到绝对没有区别。编译器在执行时忽略了这两条多行注释。
编译器会忽略这两个注释,是的。编译器所做的事情没有区别。
不同之处在于,您可以使用 Javadoc 工具将 Javadoc 注释(而非普通注释)转换为 this 之类的文档。 (许多 IDE,如 Eclipse 或 IntelliJ,也将以这种格式显示文档,例如,当您将鼠标悬停在您正在调用的方法上时。)
编译为 class 时,普通注释会被删除。
Javadoc 不会像常规注释那样保留在代码中,可用于自动生成 HTML 文档,您可以发布这些文档以供人们理解您的 API。
Javadoc 示例:
https://docs.javacord.org/api/v/3.4.0/
Javadoc 与编译代码或任何其他运行时行为无关。
在那里,程序员可以对 类、变量和方法进行注释。全部 in-place,不需要外部评论或文件。
当你有像 Eclipse 或 IntelliJ 这样的 IDE 时,当你将鼠标悬停在其他地方的方法调用上时,它会显示这些注释。
Javadoc也可以从源代码中读取(.java类)编译成HTML页,就像所有主要的Java 文档是。
看看这个,这是一个很好的概述:https://www.baeldung.com/javadoc