@code java 注释有什么作用

2022-09-01 09:53:38

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

从前面的问题中,我意识到它与html有关,但我不确定到底是什么......

说javadoc默认被解析为HTML是正确的吗?但是将注释放在一些javadoc文本旁边会表明它应该被视为代码,而不是以通常的方式解析/呈现?例如:@code

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

这是否是其使用的适当例子?


答案 1

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

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


答案 2

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

enter image description here

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

如果要检查如果不添加的格式更改,可以参考以下问题: Javadoc 注释中的多行代码示例@code


推荐