@code java注解有啥作用

Posted 2023-03-05

【中文标题】@code java注解有啥作用

【英文标题】：What does the @code java annotation do@code java注解有什么作用

【发布时间】：2013-10-18 14:12:21

【问题描述】：

我尝试在 Oracle 文档中搜索以了解 @code java注解可以。

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

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

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

这是一个恰当的使用例子吗？

【问题讨论】：

我认为您正在寻找有关 Javadoc 的一些解释：***.com/questions/541920/…

【参考方案1】：

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

Javadocs 是用于类描述、构造函数和方法的特殊格式的源代码 cmets，可帮助生成有关源代码的 HTML 文档。例如，使用reading online 的Javadocs 或在IDE 中完整记录了Java API。详情请见Java API Documentation Generator。

【参考方案2】：

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

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

如果您想检查不添加@code时发生的格式更改，可以参考以下问题：Multiple line code example in Javadoc comment