32

我尝试在 Oracle 文档中搜索以了解 @code java 注释的作用。

从上一个问题中，我意识到它与html有关，但我不确定究竟是什么......

说默认情况下 javadoc 被解析为 HTML 是否正确......但是将@code注释放在一些 javadoc 文本旁边将表明它应该被视为代码，而不是以通常的方式解析/呈现？例如：

    /**
    *This is how to declare an int variable {@code int var=1;}
    */

这会是它使用的适当例子吗？

4

2 回答 2

46

{@code ...}是一个 Javadoc 标记，它告诉 Javadoc 大括号内的文本是源代码，不应被视为 HTML。Javadoc 还应该以不同于其他文本的方式格式化代码块中的文本。这与 StackOverflow 编辑器在您格式化问题或答案时使用的“代码示例”文本的概念相似。

Javadocs 是用于类描述、构造函数和方法的特殊格式的源代码注释，可帮助生成有关源代码的 HTML 文档。例如，Java API 使用 Javadocs 进行了完整的文档化，以便在线阅读或在 IDE 中阅读。有关详细信息，请参阅Java API 文档生成器。

于 2013-10-10T17:33:02.330 回答
-5

如果要为方法添加 JavaDocs。也许你不知道什么是 Javadocs

在此处输入图像描述

所以这里黄色的东西是一个Javadoc 如果你想为一个方法添加一个Javadoc的代码，那么你可以@code使用该方法为其他人注释它，以查看该方法作为示例。以及为什么我们需要使用它，因为如果我们不这样做，那么格式将不正确

如果您想检查不添加时发生的格式更改，可以参考以下问题@code：Javadoc 注释中的多行代码示例

于 2013-10-10T17:31:06.363 回答