@code java注释做了什么

Question

我尝试在Oracle文档中搜索有关内容的解释 @code java注释。

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

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

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

这是一个适当的例子吗？

Answer 1

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

Answer 2

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

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

如果您要在未添加@code的情况下检查格式更改，可以参考以下问题：Multiple line code example in Javadoc comment